{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "RustSC customer API v1 schemas",
  "$defs": {
    "AcceptWaitingInvitationBody": {
      "properties": {
        "invitationId": {
          "type": "string",
          "description": "Invitation ID."
        },
        "workspaceId": {
          "type": "string",
          "description": "Workspace ID."
        }
      },
      "required": [
        "workspaceId",
        "invitationId"
      ],
      "type": "object",
      "description": "A waiting invitation to accept: its workspace and its ID, as `listWaitingInvitations` gave them."
    },
    "AccountActivityEventResponse": {
      "properties": {
        "address": {
          "type": [
            "null",
            "string"
          ],
          "description": "The address with its last part hidden, for example `203.0.113.x`. Shown only to the account itself."
        },
        "at": {
          "format": "date-time",
          "type": "string"
        },
        "client": {
          "type": [
            "null",
            "string"
          ],
          "description": "The browser, for example `Chrome`. Null when it did not say."
        },
        "clientVersion": {
          "type": [
            "null",
            "string"
          ]
        },
        "country": {
          "type": [
            "null",
            "string"
          ],
          "description": "The two-letter country of the address. Approximate; null when unknown."
        },
        "deviceKind": {
          "type": [
            "null",
            "string"
          ],
          "description": "`computer`, `phone`, `tablet` or `unknown`."
        },
        "deviceModel": {
          "type": [
            "null",
            "string"
          ]
        },
        "id": {
          "type": "string",
          "description": "Opaque ID of the event, stable for a list key. Not a session ID."
        },
        "kind": {
          "type": "string",
          "description": "What happened: `sign_in`, `sign_in_failed`, `sign_out`, `session_revoked`, `sign_out_everywhere`, `account_created`, `passkey_added`, `passkey_removed`, `method_linked`, `method_unlinked`, `account_deletion_requested`, `account_deletion_cancelled` or `events_capped` (a busy hour: later events of that hour were not listed). New words may be added; show an unknown one plainly."
        },
        "method": {
          "type": [
            "null",
            "string"
          ],
          "description": "The sign-in method the event is about: `email_code`, `passkey`, `google`, `discord` or `app`. Null when it has none."
        },
        "os": {
          "type": [
            "null",
            "string"
          ]
        },
        "osVersion": {
          "type": [
            "null",
            "string"
          ]
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "A short machine word for why something failed or ended, for example `code_invalid`. Null when there is none."
        },
        "result": {
          "type": "string",
          "description": "`succeeded` or `denied`."
        }
      },
      "required": [
        "id",
        "kind",
        "result",
        "at"
      ],
      "type": "object",
      "description": "One thing that happened to the account's sign-in. The User-Agent text and the full address are never part of it."
    },
    "AccountActivityResponse": {
      "properties": {
        "events": {
          "items": {
            "$ref": "#/$defs/AccountActivityEventResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "events"
      ],
      "type": "object",
      "description": "The newest security events of the account, newest first: at most 20."
    },
    "AccountAgeRuleBody": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "message": {
          "type": "string"
        },
        "minDays": {
          "format": "int32",
          "type": "integer",
          "description": "1 to 3650."
        },
        "unknown": {
          "type": "string"
        }
      },
      "required": [
        "enabled",
        "minDays",
        "unknown",
        "message"
      ],
      "type": "object",
      "description": "Players whose Steam account is younger than `minDays` days are removed."
    },
    "AccountAlertsRequest": {
      "properties": {
        "newSignIn": {
          "type": [
            "null",
            "boolean"
          ]
        }
      },
      "required": [
        "newSignIn"
      ],
      "type": "object",
      "description": "Save the account's own alerts. The whole set is sent."
    },
    "AccountAlertsResponse": {
      "properties": {
        "newSignIn": {
          "type": "boolean",
          "description": "Tell my browsers when someone signs in to my account. They get the browser or app, the system and an approximate country, never an address."
        }
      },
      "required": [
        "newSignIn"
      ],
      "type": "object",
      "description": "The alerts the signed-in person switched on for their own account. All off until saved."
    },
    "AccountDeletionResponse": {
      "properties": {
        "canDelete": {
          "type": "boolean",
          "description": "True when nothing blocks the deletion: no workspace answers `blocked`."
        },
        "dueAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the account is erased, while it is scheduled."
        },
        "requestedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "state": {
          "type": "string"
        },
        "workspaces": {
          "items": {
            "$ref": "#/$defs/AccountDeletionWorkspaceResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "state",
        "workspaces",
        "canDelete"
      ],
      "type": "object",
      "description": "What deleting the signed-in account does, and whether it is scheduled. `workspaces` lists each workspace the account\nbelongs to with what happens to it."
    },
    "AccountDeletionWorkspaceResponse": {
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "outcome": {
          "type": "string",
          "description": "`close`: the account is the only member, so the workspace closes and is deleted after the export window. `leave`: others remain, the account just leaves. `closing`: already closing. `blocked`: the account is the last owner of a workspace with other members; make someone else an owner first."
        }
      },
      "required": [
        "id",
        "name",
        "outcome"
      ],
      "type": "object",
      "description": "One workspace of an account that is being deleted."
    },
    "AccountResponse": {
      "properties": {
        "deletionDueAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the account is deleted, while a deletion is scheduled; null otherwise. Keeping the account cancels it."
        },
        "email": {
          "type": "string",
          "description": "The verified email address the account signs in with."
        },
        "id": {
          "type": "string",
          "description": "Account ID, for example `acc_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        }
      },
      "required": [
        "id",
        "email"
      ],
      "type": "object",
      "description": "The signed-in person's own account."
    },
    "AccountSupportRequest": {
      "properties": {
        "message": {
          "type": "string"
        },
        "subject": {
          "type": "string"
        },
        "submissionKey": {
          "type": "string"
        },
        "topic": {
          "type": "string"
        },
        "workspaceId": {
          "type": [
            "null",
            "string"
          ],
          "description": "Optional explicit workspace association, using the typed workspace ID from your directory. Sending without one remains account-level support."
        }
      },
      "required": [
        "topic",
        "subject",
        "message",
        "submissionKey"
      ],
      "type": "object",
      "description": "Account-level support input; identity always comes from the authenticated session."
    },
    "AddBattleMetricsBanListBody": {
      "properties": {
        "list": {
          "type": "string",
          "description": "The list's id (a UUID) or the address of the list's page on battlemetrics.com; the id is read from it."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "What the member calls the list, 1 to 60 characters; optional (the list is called BattleMetrics ban list)."
        },
        "token": {
          "type": "string",
          "description": "The member's own read-only BattleMetrics token (it needs only the read bans scope)."
        }
      },
      "required": [
        "list",
        "token"
      ],
      "type": "object",
      "description": "A BattleMetrics ban list to add (`POST /ban-settings/battlemetrics-lists`)."
    },
    "AddCommunityBanListBody": {
      "properties": {
        "address": {
          "type": "string",
          "description": "The `https` address of a list in Rust's centralized banning format: RustSC asks `address + Steam ID`; 404 means not listed and a JSON answer means\nlisted. It may hold a key; it is stored, never shown again and never logged."
        },
        "appealsUrl": {
          "type": [
            "null",
            "string"
          ],
          "description": "Where a listed player can appeal; an `https` or `http` address, optional."
        },
        "name": {
          "type": "string",
          "description": "1 to 60 characters."
        },
        "runBy": {
          "type": "string",
          "description": "Who runs the list, 1 to 60 characters."
        }
      },
      "required": [
        "name",
        "runBy",
        "address"
      ],
      "type": "object",
      "description": "A community list to add (`POST /ban-settings/lists`)."
    },
    "AddFromPluginInboxBody": {
      "properties": {
        "addAnyway": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "File names that were flagged and are added anyway."
        },
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "fileNames": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The plugin file names to add; leave it out to add every file that is added by default."
        },
        "framework": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object"
    },
    "AddPlayerLabelRequestBody": {
      "properties": {
        "label": {
          "type": "string",
          "description": "The label: 1 to 30 characters, at most 10 for one player."
        },
        "steamId": {
          "type": "string",
          "description": "The player's Steam ID, 17 digits."
        }
      },
      "required": [
        "steamId",
        "label"
      ],
      "type": "object",
      "description": "Adds a label to a player. A player with that label already is left as is."
    },
    "AddRoleBenefitBody": {
      "properties": {
        "graceHours": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Hours between finding eligibility lost and taking the role back, 0 to 168; default 24. Unlinking always takes it back at once."
        },
        "roleId": {
          "type": "string",
          "description": "The Discord role to give."
        },
        "source": {
          "type": "string",
          "description": "`linked` or `boosting`."
        }
      },
      "required": [
        "source",
        "roleId"
      ],
      "type": "object"
    },
    "AddRoleSyncBody": {
      "properties": {
        "allowStaff": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Only an Owner: allow writing to a staff group, with `confirmGroup` the group's name typed."
        },
        "confirmGroup": {
          "type": [
            "null",
            "string"
          ]
        },
        "direction": {
          "type": "string"
        },
        "graceHours": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "group": {
          "type": "string"
        },
        "removeWhenLost": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Default true."
        },
        "roleId": {
          "type": "string"
        },
        "serverId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The one server, or null for every server (one-way only; both ways needs one server)."
        },
        "takeOver": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Default false: players who held the group or the role before are left alone."
        }
      },
      "required": [
        "roleId",
        "group",
        "direction"
      ],
      "type": "object"
    },
    "AddServerRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the host is busy or offline; leave it out to refuse."
            }
          ]
        },
        "branch": {
          "type": [
            "null",
            "string"
          ],
          "description": "The Steam branch to install; leave it out for the default branch, `public`."
        },
        "crashRecovery": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "The form's pre-ticked \"Restart it if it crashes\" switch. True turns automatic crash recovery on once the server is installed; false or left out\nleaves it off (a new server reads it as off until a form saves it)."
        },
        "hostId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The full host to add the server on, for example `host_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "map": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ServerMapBody",
              "description": "The map the server starts from; leave it out for the game's own default, a generated map at a random seed. The map\ncannot be changed later except by wiping the map."
            }
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "Display name, a label for lists and operation summaries."
        },
        "playerLink": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "The form's pre-ticked \"Let players link in the game\" switch. True lets players use /link in the game once the server is installed; false or left out sends nothing, so it stays off."
        },
        "ports": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ServerPortsBody",
              "description": "The server's ports, each 1024 to 65535, with different game and query ports; leave it out\nfor the conventional ports (game 28015, query 28017, RCON 28016)."
            }
          ]
        },
        "root": {
          "type": [
            "null",
            "string"
          ],
          "description": "The existing folder on the host to install into, as an absolute path of ASCII letters,\ndigits, '.', '_' and '-' segments, for example `/srv/rust/example-server`."
        }
      },
      "type": "object",
      "description": "Adds a server on a host and installs the Rust dedicated server into its root."
    },
    "AddToPluginLibraryBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "files": {
          "items": {
            "$ref": "#/$defs/DroppedPluginBody"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The files, each already on the host in the library's inbox folder (the upload puts it there)."
        },
        "framework": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object"
    },
    "AddWipeExtraBody": {
      "properties": {
        "address": {
          "type": [
            "null",
            "string"
          ],
          "description": "For plugin_source only: the https address the member approved after `checkWipePluginAddress`. The one file in `files` is the size and fingerprint the check\nreported; the extra is ready at once and the host fetches the file at the wipe, installing it only while it is that file."
        },
        "files": {
          "items": {
            "$ref": "#/$defs/WipeFileBody"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The files, for add_files and plugin_source; the bytes follow by upload."
        },
        "kind": {
          "type": [
            "null",
            "string"
          ],
          "description": "`add_files`, `remove_paths`, `plugin_source` or `leave_out`."
        },
        "label": {
          "type": [
            "null",
            "string"
          ],
          "description": "What the member calls it, 1 to 40 characters."
        },
        "leavesOut": {
          "type": [
            "null",
            "string"
          ]
        },
        "planId": {
          "type": [
            "null",
            "string"
          ]
        },
        "repeat": {
          "type": [
            "null",
            "string"
          ]
        },
        "target": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/WipeTargetBody"
            }
          ]
        },
        "templateId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The template (`wtp_...`); a line repeats at every wipe that uses it."
        },
        "uploadId": {
          "type": [
            "null",
            "string"
          ],
          "description": "For add_files and a plugin_source the member uploaded: the upload (`upl_...`) the files came from. The extra is ready as soon as the server's host has confirmed that it\nholds them (at once when it already has), waits while the host is taking them, and says why when the upload ended badly. Absent leaves the extra uploading."
        },
        "versionLabel": {
          "type": [
            "null",
            "string"
          ],
          "description": "For an address: the plugin version the check read from the file, up to 64 characters, for sentences."
        }
      },
      "type": "object"
    },
    "AdmissionBody": {
      "properties": {
        "ifBusy": {
          "type": [
            "null",
            "string"
          ],
          "description": "`reject` (default) or `queue`."
        },
        "ifOffline": {
          "type": [
            "null",
            "string"
          ],
          "description": "`reject` (default) or `queue`."
        },
        "notAfter": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The latest start; required when either choice is `queue`."
        }
      },
      "type": "object"
    },
    "AdoptAgainRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the server is busy or its host is offline; leave it out to refuse."
            }
          ]
        },
        "adoptionOperationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The most recent failed adoption operation, with reason `preview_changed`."
        },
        "previewOperationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The successful preview for the same server and folder, requested after the adoption failed."
        }
      },
      "type": "object",
      "description": "Adds a server whose adoption stopped because the folder changed, using the folder as it is now. The earlier entries are kept."
    },
    "AdoptServerRequestBody": {
      "properties": {
        "acknowledgeUnverifiedProcesses": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Ignored; accepted so older clients keep working."
        },
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the host is busy or offline; leave it out to refuse."
            }
          ]
        },
        "crashRecovery": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "The form's pre-ticked \"Restart it if it crashes\" switch. True turns automatic crash recovery on once the adoption ends; false or left out leaves it off."
        },
        "hostId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The full host the folder is on, the host of the preview."
        },
        "identity": {
          "type": [
            "null",
            "string"
          ],
          "description": "The Rust identity folder under `server/` whose `server.cfg` is imported. Leave it out\nwhen the preview found exactly one; name one of them when it found several, or the identity the\ngame will use when it found none."
        },
        "importSettings": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "The form's pre-ticked \"Import the server's existing settings and configs as they are\" choice. Left out or true saves what the preview found\nas the server's starting settings (a cloud record; nothing is written to the server). False saves none."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "Display name, a label for lists and operation summaries."
        },
        "nameFromGame": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True when `name` is the name the game itself carries (the form's starting name, which the member did not change). The server then follows the game's\nname when it changes, until a member renames it in RustSC. False or left out means the name was typed by a member and is never replaced by the game's."
        },
        "playerLink": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "The form's pre-ticked \"Let players link in the game\" switch. True lets players use /link in the game once the adoption ends; false or left out sends nothing, so the server stays off."
        },
        "ports": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ServerPortsBody",
              "description": "The server's ports, each 1024 to 65535, with different game and query ports; leave it out for\nthe conventional ports. A port the identity's `server.cfg` names is the one the game\nbinds, so the host uses that one."
            }
          ]
        },
        "previewOperationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The operation ID from the adoption preview you reviewed."
        },
        "rustscPlugin": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "The form's pre-ticked \"Install the RustSC plugin\" option. True installs the plugin the host carries into the folder's Oxide or Carbon plugin folder once the adoption ends (nothing when the folder has neither or both); false or left out installs nothing. Needs `plugins.manage`."
        },
        "seed": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The seed the existing world was made with, with the same rules as `worldSize`."
        },
        "worldSize": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The world size in metres the existing world was made with. Leave it out to launch the game's\ndefault. Never read from a save file's name; a `server.cfg` line wins."
        }
      },
      "type": "object",
      "description": "Adopts the folder a succeeded preview inspected as a managed server."
    },
    "AdvancedConfigurationResponse": {
      "properties": {
        "extraArgumentsMaxLength": {
          "format": "int32",
          "type": "integer",
          "description": "The longest extra arguments text accepted, in characters."
        },
        "extraArgumentsMaxWords": {
          "format": "int32",
          "type": "integer",
          "description": "The most words the extra arguments may hold."
        },
        "launchFlags": {
          "items": {
            "$ref": "#/$defs/LaunchFlagResponse"
          },
          "type": "array",
          "description": "The startup flags a person can turn on, in display order. Each is saved by name in `rustsc.launch_flags`."
        },
        "variableListBuild": {
          "format": "int32",
          "type": "integer",
          "description": "The Steam build the portal's list of the game's own variables was measured on."
        }
      },
      "required": [
        "launchFlags",
        "extraArgumentsMaxLength",
        "extraArgumentsMaxWords",
        "variableListBuild"
      ],
      "type": "object",
      "description": "The startup flags and extra argument limits of the Advanced settings."
    },
    "AlertChangeResponse": {
      "properties": {
        "field": {
          "type": "string"
        },
        "from": {
          "type": "string",
          "description": "`on`, `off` or a number of minutes or percent; empty when the field has none."
        },
        "kind": {
          "type": "string"
        },
        "to": {
          "type": "string"
        }
      },
      "required": [
        "kind",
        "field",
        "from",
        "to"
      ],
      "type": "object",
      "description": "One field that applying a template would change."
    },
    "AlertComputerSystemsResponse": {
      "properties": {
        "linux": {
          "format": "int32",
          "type": "integer"
        },
        "windows": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "windows",
        "linux"
      ],
      "type": "object",
      "description": "How many hosts run each system."
    },
    "AlertKindBody": {
      "properties": {
        "allServers": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True (the default) covers every server; false needs `servers`. Only for an event about a server."
        },
        "browser": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Whether members' browsers get the alert; default true."
        },
        "channels": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The Discord channels (`rte_`) and webhooks (`whk_`) the alert goes to: exactly the ones ticked, none when empty. Left out keeps what is saved."
        },
        "kind": {
          "type": "string"
        },
        "limitMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "on": {
          "type": "boolean"
        },
        "phone": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Whether members' phones get the alert; default true."
        },
        "pingRoleId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The Discord role (17 to 20 digits) the alert's first notice pings; left out pings nobody. Only for an alert whose entry says `offersPing`."
        },
        "pingRoleName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The pinged role's name, for the screen only (at most 100 characters)."
        },
        "reminderMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "reminders": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Whether it repeats as a reminder; default true for an alert that can."
        },
        "servers": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The servers (`srv_`) the event covers when `allServers` is false."
        },
        "threshold": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "unit": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `disk_low` only: `gb` (the default) or `percent`, the unit of `threshold`. Left out for every other alert."
        },
        "waitMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        }
      },
      "required": [
        "kind",
        "on"
      ],
      "type": "object",
      "description": "What one alert should be. A number left out is the standard one; a field the alert does not have must be left out."
    },
    "AlertManagerBaseResponse": {
      "properties": {
        "id": {
          "type": "string",
          "description": "`standard`, `essentials`, `everything` or a member-made template's ID (`atp_`)."
        },
        "kind": {
          "type": "string",
          "description": "`builtin` or `custom`."
        },
        "name": {
          "type": "string"
        },
        "newerVersion": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The template's version now, when newer than the one applied."
        },
        "removed": {
          "type": "boolean",
          "description": "True when the template no longer exists."
        },
        "version": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "kind",
        "id",
        "name",
        "version",
        "newerVersion",
        "removed"
      ],
      "type": "object",
      "description": "The template the settings began from."
    },
    "AlertManagerBoundsResponse": {
      "properties": {
        "maxDiskGigabytes": {
          "format": "int32",
          "type": "integer"
        },
        "maxDiskPercent": {
          "format": "int32",
          "type": "integer"
        },
        "maxLimitMinutes": {
          "format": "int32",
          "type": "integer"
        },
        "maxNameLength": {
          "format": "int32",
          "type": "integer"
        },
        "maxReminderMinutes": {
          "format": "int32",
          "type": "integer"
        },
        "maxTemplates": {
          "format": "int32",
          "type": "integer"
        },
        "maxThreshold": {
          "format": "int32",
          "type": "integer"
        },
        "minDiskGigabytes": {
          "format": "int32",
          "type": "integer",
          "description": "The low disk space limit in gigabytes: 1 to 10000."
        },
        "minDiskPercent": {
          "format": "int32",
          "type": "integer",
          "description": "The low disk space limit in percent of the volume left free: 1 to 50."
        },
        "minLimitMinutes": {
          "format": "int32",
          "type": "integer"
        },
        "minReminderMinutes": {
          "format": "int32",
          "type": "integer"
        },
        "minThreshold": {
          "format": "int32",
          "type": "integer"
        },
        "reminderChoices": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": "array"
        },
        "standardReminderMinutes": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "minReminderMinutes",
        "maxReminderMinutes",
        "reminderChoices",
        "standardReminderMinutes",
        "minThreshold",
        "maxThreshold",
        "minLimitMinutes",
        "maxLimitMinutes",
        "maxTemplates",
        "maxNameLength",
        "minDiskGigabytes",
        "maxDiskGigabytes",
        "minDiskPercent",
        "maxDiskPercent"
      ],
      "type": "object",
      "description": "What a value may be."
    },
    "AlertManagerChannelResponse": {
      "properties": {
        "channelName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The channel's name in Discord when it was picked, without the #; null while the channel needs to be reconnected."
        },
        "enabled": {
          "type": "boolean"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the member gave the channel; null when it has none, and the menu then shows the channel's Discord name."
        },
        "needsReconnect": {
          "type": "boolean",
          "description": "True when the channel has no Discord channel yet and sends nothing until one is picked on Alert Destinations."
        }
      },
      "required": [
        "id",
        "channelName",
        "enabled"
      ],
      "type": "object",
      "description": "A channel the alerts can be sent to."
    },
    "AlertManagerEntryResponse": {
      "properties": {
        "allServers": {
          "type": "boolean",
          "description": "True when the event covers every server."
        },
        "browser": {
          "type": "boolean",
          "description": "Whether members' browsers get this alert."
        },
        "channels": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The Discord channels (`rte_`) and webhooks (`whk_`) the alert goes to: exactly the ones ticked, none when empty."
        },
        "computersDiffer": {
          "format": "int32",
          "type": "integer",
          "description": "For a host alert, how many hosts hold something other than `values` (set on the host's own page)."
        },
        "differs": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The fields of this alert that are not what that template set: `on`, `reminders`, `reminderMinutes`, `waitMinutes`, `threshold`, `limitMinutes`."
        },
        "group": {
          "type": "string",
          "description": "The subgroup: `servers`, `computers`, `backups`, `work`, `players` or `discord`."
        },
        "kind": {
          "type": "string",
          "description": "The alert's key: `server_down`, `server_unresponsive`, `host_offline`, `operation_failed`, `occurrence_skipped`, `timed_change_failed`, `save_fallback`, `console_flooding`, `server_not_restarted`, `disk_low`, `disk_full`, `volume_read_only`, `server_low_fps`, `cpu_high`, `memory_high`, `disk_queue_high`, `os_updates_pending` or `host_software_outdated`, and the events (for example `player_joined`, `os_update_failed` or `discord_link_created`). A key you do not know is a newer alert: show it by its key."
        },
        "offersLimit": {
          "type": "boolean"
        },
        "offersPing": {
          "type": "boolean",
          "description": "True when the alert's first notice is a card in Discord that can ping a role (an alert about a server). The card's words are RustSC's and fixed."
        },
        "offersReminders": {
          "type": "boolean"
        },
        "offersWait": {
          "type": "boolean"
        },
        "onComputer": {
          "type": "boolean",
          "description": "True for the alerts a host decides (disk, processor, memory, disk): a save writes them to every host."
        },
        "perServer": {
          "type": "boolean",
          "description": "True for an event about a server, which can be limited to some servers."
        },
        "phone": {
          "type": "boolean",
          "description": "Whether members' phones get this alert."
        },
        "pingRoleId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The Discord role (17 to 20 digits) this alert pings in its first notice, or null for nobody."
        },
        "pingRoleName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The pinged role's name, for the screen only."
        },
        "section": {
          "type": "string",
          "description": "`events` (once-off) or `ongoing` (a condition that stays until it is fixed)."
        },
        "servers": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "When `allServers` is false, the servers (`srv_`) it covers."
        },
        "standardWaitMinutes": {
          "format": "int32",
          "type": "integer",
          "description": "The standard wait in minutes, for an alert that waits; 0 otherwise."
        },
        "template": {
          "$ref": "#/$defs/AlertManagerValuesResponse",
          "description": "What the template the settings began from set for this alert."
        },
        "values": {
          "$ref": "#/$defs/AlertManagerValuesResponse"
        },
        "waitChoices": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": "array",
          "description": "The waits the screen offers, in minutes."
        }
      },
      "required": [
        "kind",
        "group",
        "values",
        "template",
        "differs",
        "onComputer",
        "offersReminders",
        "offersWait",
        "offersLimit",
        "standardWaitMinutes",
        "waitChoices",
        "channels",
        "computersDiffer",
        "section",
        "browser",
        "phone",
        "perServer",
        "allServers",
        "servers",
        "offersPing",
        "pingRoleId",
        "pingRoleName"
      ],
      "type": "object",
      "description": "One alert of the alert manager."
    },
    "AlertManagerResponse": {
      "properties": {
        "based": {
          "$ref": "#/$defs/AlertManagerBaseResponse"
        },
        "bounds": {
          "$ref": "#/$defs/AlertManagerBoundsResponse"
        },
        "canManage": {
          "type": "boolean",
          "description": "Whether the caller may change settings and templates (`alerts.manage`)."
        },
        "channels": {
          "items": {
            "$ref": "#/$defs/AlertManagerChannelResponse"
          },
          "type": "array",
          "description": "The workspace's Discord channels; empty for a caller without `integrations.read`."
        },
        "chosen": {
          "type": "boolean",
          "description": "False until a member saves the alert settings of the workspace: the entries then show the recommended values as a draft, nothing is applied and no alert fires. Saving, even without a change, makes them the workspace's choice."
        },
        "computerSystems": {
          "$ref": "#/$defs/AlertComputerSystemsResponse",
          "description": "How many of the workspace's hosts run Windows and how many another system, for the words of the restart alert. A host that has not reported its system counts in neither."
        },
        "computers": {
          "format": "int32",
          "type": "integer",
          "description": "How many hosts the workspace has."
        },
        "entries": {
          "items": {
            "$ref": "#/$defs/AlertManagerEntryResponse"
          },
          "type": "array"
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "Raised by every change; 0 while the workspace has the Standard settings. Send it back in a save to refuse one made on an older read."
        },
        "servers": {
          "items": {
            "$ref": "#/$defs/AlertManagerServerResponse"
          },
          "type": "array",
          "description": "The workspace's servers, for the choice of servers an event covers."
        },
        "webhooks": {
          "items": {
            "$ref": "#/$defs/AlertManagerWebhookResponse"
          },
          "type": "array",
          "description": "The workspace's named webhooks; empty for a caller without `integrations.read`."
        }
      },
      "required": [
        "revision",
        "canManage",
        "based",
        "entries",
        "channels",
        "computers",
        "bounds",
        "webhooks",
        "servers",
        "computerSystems",
        "chosen"
      ],
      "type": "object",
      "description": "The alert manager of a workspace."
    },
    "AlertManagerSaveBody": {
      "properties": {
        "kinds": {
          "items": {
            "$ref": "#/$defs/AlertKindBody"
          },
          "type": "array"
        },
        "revision": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The revision that was read; a save on an older one is refused with `settings_changed`."
        }
      },
      "required": [
        "kinds"
      ],
      "type": "object",
      "description": "A save of the alerts named; the others stay."
    },
    "AlertManagerServerResponse": {
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object",
      "description": "A server an event can be limited to."
    },
    "AlertManagerValuesResponse": {
      "properties": {
        "limitMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many minutes the limit must be over before the alert."
        },
        "on": {
          "type": "boolean"
        },
        "reminderMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How often a reminder repeats, in minutes, while reminders are on."
        },
        "reminders": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Whether the alert repeats as a reminder; null for an alert that never repeats."
        },
        "threshold": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The limit of a host alert in percent; null for the others."
        },
        "unit": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `disk_low` only: what `threshold` counts, `gb` (decimal gigabytes left free) or `percent` (of the volume left free). The standard is 10 `gb` (less on a disk under 100 GB), pre-filled in the form. Null for every other alert."
        },
        "waitMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How long the problem must last before the alert, in minutes; null for an alert that does not wait. For `server_not_restarted` it is the days the server may run since its game started, in minutes (1 to 30 days; 3 days is pre-filled)."
        }
      },
      "required": [
        "on",
        "reminders",
        "reminderMinutes",
        "waitMinutes",
        "threshold",
        "limitMinutes",
        "unit"
      ],
      "type": "object",
      "description": "An alert's values with the standard filled in. A field the alert does not have, or a reminder that is off, is null."
    },
    "AlertManagerWebhookResponse": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "enabled"
      ],
      "type": "object",
      "description": "A named webhook the alerts can be sent to."
    },
    "AlertPreviewResponse": {
      "properties": {
        "changes": {
          "items": {
            "$ref": "#/$defs/AlertChangeResponse"
          },
          "type": "array"
        },
        "computers": {
          "format": "int32",
          "type": "integer"
        },
        "computersChanging": {
          "format": "int32",
          "type": "integer",
          "description": "How many hosts would have their own settings changed to match."
        },
        "nothingToChange": {
          "type": "boolean"
        },
        "template": {
          "$ref": "#/$defs/AlertTemplateResponse"
        }
      },
      "required": [
        "template",
        "changes",
        "computers",
        "computersChanging",
        "nothingToChange"
      ],
      "type": "object",
      "description": "What applying a template would do."
    },
    "AlertRouteChangeBody": {
      "properties": {
        "categories": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "What the route sends; at least one of `availability`, `operations` and `resources`."
        },
        "channelId": {
          "type": [
            "null",
            "string"
          ],
          "description": "A different channel for the route, or the channel that reconnects a route that needs it; absent keeps the saved one."
        },
        "enabled": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Whether the route sends. Default true."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "A new name for the channel; absent keeps the saved name, blank removes it."
        },
        "showSteamIds": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Whether this channel's alerts add each player's Steam ID and profile link after the name; absent keeps the saved choice."
        }
      },
      "required": [
        "categories"
      ],
      "type": "object",
      "description": "A change to a route. `PUT` replaces the categories and the switch; the channel stays unless a new one is given."
    },
    "AlertRouteCreateBody": {
      "properties": {
        "categories": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "What the route sends: any of `availability` (a server or host offline or crashed), `operations` (a backup, update or start that failed) and `resources` (low disk space, high CPU or memory use). At least one."
        },
        "channelId": {
          "type": "string",
          "description": "The channel's Discord ID, from the list of `listDiscordPostChannels`. Checked again against the workspace's own connected Discord server."
        },
        "enabled": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Whether the route sends now. Default false: a new Discord channel posts nothing until it is switched on."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "A name for the channel, shown in the menus of Alert settings (at most 60 characters). Optional; absent or blank means none, and Discord's channel name is shown."
        },
        "showSteamIds": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Whether this channel's alerts add each player's Steam ID and profile link after the name. Default false: alerts name players without their Steam ID."
        }
      },
      "required": [
        "channelId",
        "categories"
      ],
      "type": "object",
      "description": "A new alert route: a channel of the workspace's connected Discord server that the RustSC bot posts in."
    },
    "AlertRouteDeliveryResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": "string"
        },
        "problem": {
          "type": [
            "null",
            "string"
          ],
          "description": "When `failed`: `reconnect` (the route has no channel yet), `no_bot`, `cannot_post`, `channel_gone`, `channel_changed` (the channel was changed in Discord, so posting stopped until it is picked again), `unreachable`, `bad_request`, `rate_limited`, `route_off` (the channel was switched off while the alert waited) or `other`; otherwise null."
        },
        "state": {
          "type": "string",
          "description": "`sent`, `uncertain` (it may have been posted and is not repeated) or `failed`."
        }
      },
      "required": [
        "state",
        "problem",
        "at"
      ],
      "type": "object",
      "description": "The newest finished delivery to a route."
    },
    "AlertRouteListResponse": {
      "properties": {
        "canManage": {
          "type": "boolean",
          "description": "Whether the signed-in member may create, change, test and remove routes (`integrations.manage`)."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/AlertRouteResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items",
        "canManage"
      ],
      "type": "object",
      "description": "A workspace's alert routes."
    },
    "AlertRouteResponse": {
      "properties": {
        "categories": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "What the route sends: `availability`, `operations`, `resources`."
        },
        "channel": {
          "type": "string",
          "description": "`discord`."
        },
        "channelId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The Discord channel the bot posts in; null while the route needs to be reconnected."
        },
        "channelName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The channel's name in Discord when it was picked, without the #; null while the route needs to be reconnected."
        },
        "channelSetup": {
          "type": [
            "null",
            "string"
          ],
          "description": "What needs fixing about how RustSC posts in the channel, or null: `changed` (the channel was changed in Discord, so posting stopped until the member picks the channel again)\nor `needs_fix` (RustSC could not set the channel up; the bot keeps posting and the portal offers Fix in Discord). Null for every channel until webhooks for posts are switched on."
        },
        "channelSetupLink": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `needs_fix`: the channel's address in Discord, opened by the Fix in Discord button; otherwise null."
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "id": {
          "type": "string",
          "description": "The route's ID (`rte_`)."
        },
        "lastDelivery": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AlertRouteDeliveryResponse",
              "description": "The newest finished delivery, or null before the first."
            }
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the member gave the channel; null when it has none."
        },
        "needsReconnect": {
          "type": "boolean",
          "description": "True when the route has no channel yet and sends nothing until one is picked (it was saved with a link before the bot became the only way to post)."
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "Raised by every change."
        },
        "showSteamIds": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Whether this channel's alerts add each player's Steam ID and profile link after the name. False unless a member turned it on."
        },
        "updatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "id",
        "channel",
        "categories",
        "enabled",
        "channelId",
        "channelName",
        "needsReconnect",
        "revision",
        "createdAt",
        "updatedAt",
        "lastDelivery"
      ],
      "type": "object",
      "description": "One alert route."
    },
    "AlertRouteTestBody": {
      "properties": {
        "channelId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The channel to test, for example one just picked and not yet saved."
        }
      },
      "type": "object",
      "description": "Posts one test alert. Absent `channelId` uses the saved route's channel (`POST .../alert-routes/{routeId}/test`); the route-less form needs the channel."
    },
    "AlertRouteTestResponse": {
      "properties": {
        "missing": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "For `cannot_post`: what the bot lacks in the channel, in Discord's words (`View Channel`, `Send Messages`, `Embed Links`); otherwise empty."
        },
        "problem": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why not: `reconnect`, `no_bot`, `cannot_post` (see `missing`), `channel_gone`, `unreachable`, `bad_request`, `rate_limited`, `unconfirmed` (Discord did not confirm the test: a time limit or a server error, so the card may be in the channel) or `other`; null when sent."
        },
        "sent": {
          "type": "boolean"
        }
      },
      "required": [
        "sent",
        "problem",
        "missing"
      ],
      "type": "object",
      "description": "Whether Discord took the test alert."
    },
    "AlertRuleSettingBody": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "minutes": {
          "format": "int32",
          "type": "integer",
          "description": "How many minutes the condition must last, 1 to 60."
        },
        "threshold": {
          "format": "int32",
          "type": "integer",
          "description": "Percent, 10 to 100."
        }
      },
      "required": [
        "enabled",
        "threshold",
        "minutes"
      ],
      "type": "object",
      "description": "One optional alert as the portal shows and saves it."
    },
    "AlertTemplateApplyBody": {
      "properties": {
        "templateId": {
          "type": "string"
        },
        "templateVersion": {
          "format": "int32",
          "type": "integer",
          "description": "The template's version in the preview; a different one is refused with `template_changed`."
        }
      },
      "required": [
        "templateId",
        "templateVersion"
      ],
      "type": "object",
      "description": "The template to apply and the version that was previewed."
    },
    "AlertTemplateChoiceBody": {
      "properties": {
        "templateId": {
          "type": "string",
          "description": "`standard`, `essentials`, `everything` or a member-made template's ID (`atp_`)."
        }
      },
      "required": [
        "templateId"
      ],
      "type": "object",
      "description": "The template to look at or apply."
    },
    "AlertTemplateListResponse": {
      "properties": {
        "canManage": {
          "type": "boolean"
        },
        "items": {
          "items": {
            "$ref": "#/$defs/AlertTemplateResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "canManage",
        "items"
      ],
      "type": "object",
      "description": "The templates a workspace can apply."
    },
    "AlertTemplateResponse": {
      "properties": {
        "alertsOn": {
          "format": "int32",
          "type": "integer"
        },
        "alertsTotal": {
          "format": "int32",
          "type": "integer"
        },
        "id": {
          "type": "string"
        },
        "kind": {
          "type": "string",
          "description": "`builtin` or `custom`."
        },
        "name": {
          "type": "string"
        },
        "version": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "id",
        "kind",
        "name",
        "version",
        "alertsOn",
        "alertsTotal"
      ],
      "type": "object",
      "description": "A template of the workspace, built-in or member-made."
    },
    "AlertTemplateSaveBody": {
      "properties": {
        "name": {
          "type": "string"
        }
      },
      "required": [
        "name"
      ],
      "type": "object",
      "description": "Saves the workspace's current settings as a template."
    },
    "AlertTemplateUpdateBody": {
      "properties": {
        "fromCurrent": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True replaces the template's values with the workspace's current settings and raises its version."
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object",
      "description": "Renames a template and/or replaces its values with the current settings."
    },
    "AllowAnywayBody": {
      "properties": {
        "playerName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the player, kept so the list reads when the player is away; optional."
        }
      },
      "type": "object",
      "description": "Who to allow anyway (`PUT .../ban-allow/{steamId}`)."
    },
    "AllowAnywayItemResponse": {
      "properties": {
        "addedAt": {
          "format": "date-time",
          "type": "string"
        },
        "addedBy": {
          "$ref": "#/$defs/OperationActorResponse",
          "description": "Who added it: an account, never a name."
        },
        "playerName": {
          "type": [
            "null",
            "string"
          ]
        },
        "steamId": {
          "type": "string"
        }
      },
      "required": [
        "steamId",
        "addedAt",
        "addedBy"
      ],
      "type": "object",
      "description": "One Allowed anyway entry."
    },
    "AllowAnywayResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/AllowAnywayItemResponse"
          },
          "type": "array"
        },
        "total": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "items",
        "total"
      ],
      "type": "object",
      "description": "The workspace's Allowed anyway list, newest first: players no ban list removes."
    },
    "AllowlistRuleBody": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "message": {
          "type": "string",
          "description": "What a removed player sees, 1 to 200 characters."
        },
        "steamIds": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Steam IDs as decimal strings, at most 1,000."
        }
      },
      "required": [
        "enabled",
        "steamIds",
        "message"
      ],
      "type": "object",
      "description": "Only the listed Steam IDs may stay on the server. Owners and moderators of the game are never removed."
    },
    "AnalyticsContextResponse": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "requiresConsent": {
          "type": "boolean"
        }
      },
      "required": [
        "enabled",
        "requiresConsent"
      ],
      "type": "object"
    },
    "AnalyticsEventRequest": {
      "additionalProperties": false,
      "properties": {
        "bundle": {
          "type": [
            "null",
            "string"
          ]
        },
        "campaign": {
          "additionalProperties": {
            "type": "string"
          },
          "type": [
            "null",
            "object"
          ]
        },
        "consentGranted": {
          "type": "boolean"
        },
        "cta": {
          "type": [
            "null",
            "string"
          ]
        },
        "device": {
          "type": [
            "null",
            "string"
          ]
        },
        "entry": {
          "type": "boolean"
        },
        "errorClass": {
          "type": [
            "null",
            "string"
          ]
        },
        "kind": {
          "type": [
            "null",
            "string"
          ]
        },
        "language": {
          "type": [
            "null",
            "string"
          ]
        },
        "line": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "navigation": {
          "type": [
            "null",
            "string"
          ]
        },
        "optOut": {
          "type": "boolean"
        },
        "path": {
          "type": [
            "null",
            "string"
          ]
        },
        "ratings": {
          "additionalProperties": {
            "type": "string"
          },
          "type": [
            "null",
            "object"
          ]
        },
        "referrerHost": {
          "type": [
            "null",
            "string"
          ]
        },
        "release": {
          "type": [
            "null",
            "string"
          ]
        },
        "site": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object",
      "description": "Untrusted browser input. No identifiers, form contents or arbitrary metadata are accepted."
    },
    "AnswerSaveFallbackRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "operationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The ID of the operation being answered (op_...), as the operation routes list it."
        }
      },
      "type": "object",
      "description": "An answer to a save fallback request: the request's operation ID and the optional admission choices."
    },
    "ApiKeyListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/ApiKeyResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "Always null: the list is returned in one page."
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The number of items."
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount"
      ],
      "type": "object",
      "description": "The workspace's keys that are not revoked, newest first."
    },
    "ApiKeyMakerResponse": {
      "properties": {
        "email": {
          "type": [
            "null",
            "string"
          ],
          "description": "The member's address, when the account is known."
        },
        "membershipId": {
          "type": "string"
        }
      },
      "required": [
        "membershipId",
        "email"
      ],
      "type": "object",
      "description": "The member who made a key."
    },
    "ApiKeyResponse": {
      "properties": {
        "access": {
          "type": "string",
          "description": "`read` (reads and nothing else) or `read_write` (everything its maker can do)."
        },
        "askBeforeConsole": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "For an agent key: true (the default) when a free-form console command waits for the member's approval. Null for a plain key."
        },
        "askBeforeRisky": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "For an agent key: true (the default) when its risky actions (wipes, deleting, restoring, long ban lists, file writes, plugin install or removal) wait for the member's approval in the portal. Null for a plain key."
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "createdBy": {
          "$ref": "#/$defs/ApiKeyMakerResponse",
          "description": "The member whose permissions the key can never exceed."
        },
        "expiresAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the key stops working; null for a key that does not expire."
        },
        "id": {
          "type": "string",
          "description": "Key ID, for example `key_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "kind": {
          "type": "string",
          "description": "`api` for a key made for scripts that call the API, `agent` for a key made for an AI assistant or an unattended agent, which\nthe remote MCP endpoint accepts as well as the API. An agent key always expires, within 90 days."
        },
        "lastUsedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the key was last used, to the nearest few minutes; null if it never was."
        },
        "name": {
          "type": "string",
          "description": "The name the member gave it."
        },
        "prefix": {
          "type": "string",
          "description": "The first characters of the key text, to recognise a key by: `rsk_` and the start of the key ID."
        },
        "role": {
          "type": [
            "null",
            "string"
          ],
          "description": "The role of an agent key (`viewer`, `moderator`, `operator`, `administrator` or `owner`), the same roles an assistant has; it never holds more than the\nmember who made it. Null for a plain key, and for an agent key made before roles that could change things (it keeps the member's own role)."
        },
        "scope": {
          "type": "string",
          "description": "`workspace` (every server and the workspace itself) or `servers` (only `serverIds`)."
        },
        "serverIds": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The servers of a `servers` key; empty for `workspace`."
        },
        "state": {
          "type": "string",
          "description": "`active`, `expired` or `paused`. A revoked key is not listed."
        }
      },
      "required": [
        "id",
        "name",
        "prefix",
        "access",
        "scope",
        "serverIds",
        "createdBy",
        "createdAt",
        "expiresAt",
        "lastUsedAt",
        "state",
        "kind",
        "role",
        "askBeforeRisky",
        "askBeforeConsole"
      ],
      "type": "object",
      "description": "An integration key: what it may do, until when, and when it was last used. Never the secret."
    },
    "AppliedBackupPolicyResponse": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "installationId": {
          "type": "string"
        },
        "policyOperationId": {
          "type": [
            "null",
            "string"
          ]
        },
        "receivedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the cloud received this host observation, not a promise of current connectivity or freshness."
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "sourceOperationId": {
          "type": "string"
        }
      },
      "required": [
        "enabled",
        "revision",
        "installationId",
        "policyOperationId",
        "sourceOperationId",
        "receivedAt"
      ],
      "type": "object"
    },
    "AppliedRecoveryPreferencesResponse": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "installationId": {
          "type": "string"
        },
        "receivedAt": {
          "format": "date-time",
          "type": "string",
          "description": "The cloud report receipt time, not a freshness or connectivity guarantee."
        },
        "restartIfUnresponsive": {
          "type": "boolean",
          "description": "The server is restarted by force when it stays unresponsive for unresponsiveMinutes."
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "saveRecovery": {
          "type": [
            "null",
            "string"
          ],
          "description": "The save recovery the host uses (ask_first or automatic): the choice saved here, else the server's applied configuration, else ask_first. Null when the host's RustSC is too old to report it."
        },
        "sourceOperationId": {
          "type": "string"
        },
        "startAtBoot": {
          "type": "boolean",
          "description": "The server is started after the host restarts. A server from before this switch reads on until a choice is saved."
        },
        "unresponsiveMinutes": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "enabled",
        "revision",
        "restartIfUnresponsive",
        "unresponsiveMinutes",
        "startAtBoot",
        "saveRecovery",
        "installationId",
        "sourceOperationId",
        "receivedAt"
      ],
      "type": "object"
    },
    "ApplyAttachmentBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "ifExists": {
          "type": [
            "null",
            "string"
          ]
        },
        "manifestSha256": {
          "type": [
            "null",
            "string"
          ],
          "description": "The `manifestSha256` the attachment answered: the person approves exactly these files."
        }
      },
      "type": "object",
      "description": "Put a staged attachment on the server."
    },
    "ApplyConfigurationRequestBody": {
      "properties": {
        "acceptFileSha256": {
          "type": [
            "null",
            "string"
          ],
          "description": "The fingerprint (64 lowercase hex characters) of the server's current `server.cfg`, from a\nfailed apply's `write_files` result (`priorSha256`), to overwrite settings someone\nchanged in the file outside RustSC. Lines RustSC does not manage are kept."
        },
        "acceptWorldChange": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True when the member was told that this revision changes the map or the world and saves it anyway: another custom map file name, another bundled level, or another size\nor seed of a generated map (Rust starts a new map for each). Without it the host answers such a change with `world_exists`, naming what would change, and writes\nnothing. A map at a new address with the same file name is no change and needs no flag. Absent is false."
        },
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        }
      },
      "type": "object",
      "description": "An apply of the revision named in `If-Match`."
    },
    "ApplyEndpointsBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "expectedPlanSha256": {
          "type": "string"
        },
        "expectedRevision": {
          "format": "int64",
          "type": "integer"
        },
        "expectedScope": {
          "type": "string"
        },
        "mode": {
          "type": "string"
        },
        "ports": {
          "$ref": "#/$defs/EndpointPortsBody"
        },
        "warningSeconds": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "expectedScope",
        "expectedRevision",
        "ports",
        "expectedPlanSha256",
        "mode",
        "warningSeconds"
      ],
      "type": "object"
    },
    "ApplyPlayerPermissionsBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "framework": {
          "type": [
            "null",
            "string"
          ]
        },
        "operations": {
          "items": {
            "$ref": "#/$defs/PlayerPermissionOperationBody"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The changes, in the order the member made them (at most 500)."
        },
        "preview": {
          "type": "boolean"
        },
        "putBack": {
          "type": "boolean",
          "description": "True to put back the originals of the last change instead of applying anything."
        },
        "route": {
          "type": [
            "null",
            "string"
          ],
          "description": "True to see what each change would do and write nothing."
        }
      },
      "type": "object",
      "description": "A list of changes to apply to the stopped server's files, a preview of them, or the put back of the last change."
    },
    "ArmWipePlanBody": {
      "properties": {
        "scheduleId": {
          "type": [
            "null",
            "string"
          ],
          "description": "Needs schedules.manage."
        },
        "useExtrasAgain": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Absent or false leaves them used."
        }
      },
      "type": "object"
    },
    "AssistantApprovalChangesResponse": {
      "properties": {
        "files": {
          "items": {
            "$ref": "#/$defs/AssistantApprovalFileResponse"
          },
          "type": "array"
        },
        "folder": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a staged attachment, the folder its files go in from the game folder (for example `oxide/data`); null otherwise."
        },
        "framework": {
          "type": "string",
          "description": "`oxide` or `carbon`: the folder every path is from."
        },
        "keepsOldFiles": {
          "type": [
            "null",
            "boolean"
          ]
        },
        "manifestSha256": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a staged attachment, the fingerprint of its file list that the approval is for; null otherwise."
        },
        "moreFiles": {
          "format": "int32",
          "type": "integer",
          "description": "How many more files the call names than the list holds."
        }
      },
      "required": [
        "framework",
        "folder",
        "manifestSha256",
        "keepsOldFiles",
        "files",
        "moreFiles"
      ],
      "type": "object",
      "description": "The files an assistant's call would change. Text is shown with every key and password replaced."
    },
    "AssistantApprovalDecisionBody": {
      "properties": {
        "decision": {
          "type": "string",
          "description": "`approve` or `decline`."
        }
      },
      "required": [
        "decision"
      ],
      "type": "object",
      "description": "The member's answer to one approval."
    },
    "AssistantApprovalDiffLineResponse": {
      "properties": {
        "newLine": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "oldLine": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "op": {
          "type": "string",
          "description": "`same`, `add`, `remove` or `gap` (`skipped` unchanged lines left out)."
        },
        "skipped": {
          "format": "int32",
          "type": "integer"
        },
        "text": {
          "type": "string"
        }
      },
      "required": [
        "op",
        "text",
        "oldLine",
        "newLine",
        "skipped"
      ],
      "type": "object",
      "description": "One line of a diff."
    },
    "AssistantApprovalDiffResponse": {
      "properties": {
        "added": {
          "format": "int32",
          "type": "integer",
          "description": "Lines added in all, also those the bound left out."
        },
        "hiddenChange": {
          "type": "boolean",
          "description": "True when a value that is a password or key changed: it is hidden, so the lines may not show every change."
        },
        "lines": {
          "items": {
            "$ref": "#/$defs/AssistantApprovalDiffLineResponse"
          },
          "type": "array"
        },
        "removed": {
          "format": "int32",
          "type": "integer"
        },
        "truncated": {
          "type": "boolean",
          "description": "True when more changed lines exist than are shown."
        }
      },
      "required": [
        "lines",
        "added",
        "removed",
        "truncated",
        "hiddenChange"
      ],
      "type": "object",
      "description": "A bounded line diff."
    },
    "AssistantApprovalFileResponse": {
      "properties": {
        "action": {
          "type": "string",
          "description": "`create`, `replace`, `keep_both` (a new name, the file there stays), `unknown` (the host did not say whether a file is there), `delete`, `discard`, `rename`, `move`, `copy`, `new_file` or `new_folder`."
        },
        "baseChanged": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "For a saved file: true when the file there now is not the revision the assistant read (the save will be refused); null when not known."
        },
        "current": {
          "type": [
            "null",
            "string"
          ],
          "description": "Where the file there now stands: `read`, `missing`, `too_large`, `not_text` or `not_checked`; null when the call does not put new content in the file."
        },
        "currentSize": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "Size of the file there now, in bytes."
        },
        "diff": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AssistantApprovalDiffResponse",
              "description": "The changed lines against the file there now; null when there is nothing to compare or the file is not text."
            }
          ]
        },
        "isText": {
          "type": "boolean"
        },
        "kind": {
          "type": "string",
          "description": "`plugin`, `library`, `config`, `data`, `language` or `other`."
        },
        "path": {
          "type": "string",
          "description": "The path from inside the Oxide or Carbon folder, for example `data/Kits/vip.json`."
        },
        "preview": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AssistantApprovalPreviewResponse",
              "description": "The start of a new text file; null when a diff is shown or the file is not text."
            }
          ]
        },
        "sha256": {
          "type": [
            "null",
            "string"
          ]
        },
        "size": {
          "format": "int64",
          "type": "integer",
          "description": "Size of the new file in bytes; 0 when the call does not carry the file."
        },
        "to": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a rename, move or copy: where it goes, from the same folder; null otherwise."
        },
        "unchanged": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True when the new text is the text there now."
        },
        "warning": {
          "type": [
            "null",
            "string"
          ],
          "description": "`no_info_header` for a plugin file without its header; null otherwise."
        }
      },
      "required": [
        "path",
        "to",
        "kind",
        "action",
        "size",
        "sha256",
        "isText",
        "warning",
        "current",
        "currentSize",
        "baseChanged",
        "unchanged",
        "diff",
        "preview"
      ],
      "type": "object",
      "description": "One file an assistant's call would change."
    },
    "AssistantApprovalListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/AssistantApprovalResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "Always null: the list is returned in one page."
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The number of items."
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount"
      ],
      "type": "object",
      "description": "The member's own assistant approvals, newest first."
    },
    "AssistantApprovalPreviewResponse": {
      "properties": {
        "text": {
          "type": "string"
        },
        "truncated": {
          "type": "boolean",
          "description": "True when the file has more than is shown."
        }
      },
      "required": [
        "text",
        "truncated"
      ],
      "type": "object",
      "description": "The start of a new text file."
    },
    "AssistantApprovalResponse": {
      "properties": {
        "appliedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "applyUntil": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When an approval stops being usable by the assistant; null until approved."
        },
        "changes": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AssistantApprovalChangesResponse",
              "description": "The files the call would change, when it is about files (a staged attachment, a file saved, files deleted, renamed or copied); null for any other approval and in the list. Read when the assistant\nasked, so it is what the assistant was told, not a promise about the file later."
            }
          ]
        },
        "clientName": {
          "type": "string",
          "description": "The name the assistant gave itself, or the name of the agent key."
        },
        "connectionId": {
          "type": "string",
          "description": "The assistant's connection ID (`oab_...`), or the agent key's ID (`key_...`) for a request an unattended key made."
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "decidedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "details": {
          "type": "string",
          "description": "The call's details as JSON text, long values shortened, for a Details disclosure. Nothing runs from this text."
        },
        "expiresAt": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string",
          "description": "Approval ID, for example `apv_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "kind": {
          "type": "string",
          "description": "`risky` or `console`: which of the assistant's two \"ask first\" switches applies."
        },
        "planHash": {
          "type": "string",
          "description": "The identifier of the request the approval covers."
        },
        "state": {
          "type": "string",
          "description": "`waiting`, `approved`, `declined`, `applied` (the assistant used the approval) or `expired` (not approved in time, or not used in time)."
        },
        "summary": {
          "type": "string",
          "description": "What will happen, in plain words."
        }
      },
      "required": [
        "id",
        "connectionId",
        "clientName",
        "summary",
        "kind",
        "details",
        "changes",
        "planHash",
        "state",
        "createdAt",
        "expiresAt",
        "decidedAt",
        "applyUntil",
        "appliedAt"
      ],
      "type": "object",
      "description": "A risky action an assistant asked for, with what the member decided."
    },
    "AssistantAskFirstBody": {
      "properties": {
        "askBeforeConsole": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "False to let this assistant run free-form console commands without asking. The member's choice and risk."
        },
        "askBeforeRisky": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "False to let this assistant run wipes, deleting, restoring, long ban lists, file writes and plugin install or removal without asking. The member's choice and risk."
        }
      },
      "required": [
        "askBeforeRisky",
        "askBeforeConsole"
      ],
      "type": "object",
      "description": "The member's two \"ask me first\" switches for an assistant."
    },
    "AssistantClientResponse": {
      "properties": {
        "host": {
          "type": [
            "null",
            "string"
          ],
          "description": "The website the assistant's identity was fetched from; null when it registered itself and nothing proves who it is."
        },
        "localApp": {
          "type": "boolean",
          "description": "True for a program on your own PC (it asks to be sent back to your PC)."
        },
        "name": {
          "type": "string",
          "description": "The name the assistant gave itself."
        },
        "verified": {
          "type": "boolean",
          "description": "True when `host` was proved by RustSC fetching the assistant's identity from it."
        }
      },
      "required": [
        "name",
        "host",
        "verified",
        "localApp"
      ],
      "type": "object",
      "description": "The AI assistant that asks to connect or is connected: who it says it is and how far that is proved."
    },
    "AssistantConnectionListResponse": {
      "properties": {
        "assistantsPausedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When every assistant of the workspace, agent keys included, was paused with the workspace's Pause button, or null when not. Shown even when no assistant is connected,\nso the person can see that a pause is on and resume it."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/AssistantConnectionResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "Always null: the list is returned in one page."
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The number of items."
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount",
        "assistantsPausedAt"
      ],
      "type": "object",
      "description": "The connected assistants a member may see: their own, or every member's with `apikeys.manage`."
    },
    "AssistantConnectionResponse": {
      "properties": {
        "allServers": {
          "type": "boolean",
          "description": "True when the assistant can reach every server of the workspace, servers added later too. False when it can reach only the servers in `serverIds`; a new assistant\nstarts with none, so it sees no server until the member who connected it chooses. It only narrows what the member holds."
        },
        "askBeforeConsole": {
          "type": "boolean",
          "description": "True (the default) while a free-form console command of this assistant waits for the member's approval; a separate switch."
        },
        "askBeforeRisky": {
          "type": "boolean",
          "description": "True (the default) while risky actions of this assistant (wipes, deleting, restoring, long ban lists, file writes, plugin install or removal) wait for the\nmember's approval in the portal. The member can switch it off for this assistant."
        },
        "canSetRole": {
          "type": "boolean",
          "description": "True when you connected this assistant, so you can change its role. Only the person who connected an assistant sets its role."
        },
        "client": {
          "$ref": "#/$defs/AssistantClientResponse"
        },
        "connectedBy": {
          "$ref": "#/$defs/ApiKeyMakerResponse",
          "description": "The member whose permissions the assistant can never exceed."
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "highestRole": {
          "type": "string",
          "description": "The highest role the member who connected the assistant could give it today: their own. A role above it is cut back to what they hold."
        },
        "id": {
          "type": "string",
          "description": "Connection ID, for example `oab_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "lastUsedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the assistant last used the connection, to the nearest few minutes; null if it never did."
        },
        "limits": {
          "items": {
            "$ref": "#/$defs/AssistantLimitResponse"
          },
          "type": "array",
          "description": "Always all six. The person can raise each and never remove one; `PUT.../limits` sets them."
        },
        "pausedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When this assistant was paused on its own, or null when it was not. A paused assistant is refused with `assistants_paused` at its next request and keeps its sign-in;\nResume brings it back. A pause of the whole workspace is `assistantsPausedAt` of the list, and holds for this assistant too."
        },
        "role": {
          "type": "string",
          "description": "The assistant's role: `viewer` (looks and changes nothing), `moderator`, `operator`, `administrator` or `owner`, the same kinds of roles people have. A new assistant is a Viewer."
        },
        "serverIds": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The servers the assistant can reach when `allServers` is false. Empty is no server. A server added later is not in the list."
        },
        "state": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "client",
        "role",
        "highestRole",
        "canSetRole",
        "askBeforeRisky",
        "askBeforeConsole",
        "allServers",
        "serverIds",
        "connectedBy",
        "createdAt",
        "lastUsedAt",
        "state",
        "pausedAt",
        "limits"
      ],
      "type": "object",
      "description": "An assistant connected to a workspace by someone signing in with OAuth."
    },
    "AssistantConsentAnswer": {
      "properties": {
        "continueUrl": {
          "type": "string"
        }
      },
      "required": [
        "continueUrl"
      ],
      "type": "object",
      "description": "Where to send the browser next: back to the sign-in, which now finds the consent."
    },
    "AssistantConsentBody": {
      "properties": {
        "allServers": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True to let the assistant see every server, those added later too. Send it with `serverIds` to say which servers a new assistant can see. Left out together with\n`serverIds`, a new assistant sees no server and an assistant you already let in keeps the servers it has."
        },
        "returnTo": {
          "type": "string",
          "description": "The sign-in request the assistant started, as the page was given it (`returnTo`)."
        },
        "serverIds": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The servers the assistant can see when `allServers` is not true. Empty is no server."
        },
        "workspaceId": {
          "type": "string",
          "description": "The workspace to connect the assistant to."
        }
      },
      "required": [
        "returnTo",
        "workspaceId"
      ],
      "type": "object",
      "description": "The member's answer to the page that asks for consent."
    },
    "AssistantConsentResponse": {
      "properties": {
        "client": {
          "$ref": "#/$defs/AssistantClientResponse"
        },
        "continueAutomatically": {
          "type": "boolean",
          "description": "True when the member already agreed to what is asked in the only workspace they could choose, so the page needs no question."
        },
        "redirectHost": {
          "type": "string",
          "description": "The address the assistant asks to be sent back to after it is let in, as a host (for example `claude.ai`), so you can see where the sign-in goes."
        },
        "wantsWrite": {
          "type": "boolean",
          "description": "True when the assistant asks to change things too, not only to look. It starts as a Viewer either way; the role is raised in Connected assistants."
        },
        "workspaces": {
          "items": {
            "$ref": "#/$defs/AssistantConsentWorkspaceResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "client",
        "wantsWrite",
        "redirectHost",
        "workspaces",
        "continueAutomatically"
      ],
      "type": "object"
    },
    "AssistantConsentServerResponse": {
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object",
      "description": "One server of a workspace in the consent page's choice of servers."
    },
    "AssistantConsentWorkspaceResponse": {
      "properties": {
        "connection": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AssistantConnectionResponse",
              "description": "This assistant's connection to the workspace, or null when it has none."
            }
          ]
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "servers": {
          "items": {
            "$ref": "#/$defs/AssistantConsentServerResponse"
          },
          "type": "array",
          "description": "The workspace's servers by name, for the choice of which ones the assistant can see (the first 500 by name)."
        }
      },
      "required": [
        "id",
        "name",
        "connection",
        "servers"
      ],
      "type": "object",
      "description": "A workspace an assistant can be connected to, with the connection that already exists."
    },
    "AssistantLimitResponse": {
      "properties": {
        "freestValue": {
          "format": "int32",
          "type": "integer",
          "description": "The freest value the person may set: ten times the starting value for a count, a tenth of it (never under one minute) for `pause_minutes`. A value outside `startingValue` and this is refused, so no limit can be removed."
        },
        "name": {
          "type": "string",
          "description": "Treat unknown names as other."
        },
        "startingValue": {
          "format": "int32",
          "type": "integer",
          "description": "The value every assistant starts with."
        },
        "value": {
          "format": "int32",
          "type": "integer",
          "description": "The value that applies now: the starting value or what the person raised it to."
        }
      },
      "required": [
        "name",
        "value",
        "startingValue",
        "freestValue"
      ],
      "type": "object",
      "description": "One safety limit of an assistant, with the value that applies, the value it starts at and the freest value the person may set."
    },
    "AssistantLimitsBody": {
      "properties": {
        "approvalsWaiting": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "changesPerHour": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "massBanPlayers": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "pauseMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "playerActionsPerHour": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "serversPerPlan": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        }
      },
      "type": "object",
      "description": "The limits to set for one assistant, as a whole: a limit left out or sent as null is its starting value, so an empty body puts every limit back. A\nvalue must be from the starting value to the freest one (`422 out_of_range` on its pointer otherwise)."
    },
    "AssistantLimitsResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/AssistantLimitResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object",
      "description": "The limits that apply to one assistant after a change."
    },
    "AttachmentFileBody": {
      "properties": {
        "contentBase64": {
          "type": [
            "null",
            "string"
          ],
          "description": "The file's bytes in base64. Give this or `text`."
        },
        "path": {
          "type": [
            "null",
            "string"
          ],
          "description": "The path from inside the framework's folder, `/` separated, such as `data/Kits/profiles/vip.json`. Never starts with `oxide/` or `carbon/`."
        },
        "text": {
          "type": [
            "null",
            "string"
          ],
          "description": "The file's text, stored exactly as sent (line endings and a byte order mark are kept). Give this or `contentBase64`."
        },
        "uploadSlotId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The upload address (`upl_...`, from `createServerAttachmentUploadAddress`) the file was sent to, for a file over 1 MiB. Give it instead of `text` and `contentBase64`;\n`path` may be left out (the address knows it). Works once, only for the connection, person and server that asked for it."
        }
      },
      "type": "object",
      "description": "One file an assistant attaches."
    },
    "AttachmentFileResponse": {
      "properties": {
        "filePath": {
          "type": "string",
          "description": "The path from inside the framework's folder, as sent. The member is not called `path` on purpose: the shared redactor reads a field of that name as a web address and replaces\nevery segment that holds a digit or a space (`tier1`, `My Plugin`) in an assistant's result, which would give back a path that is not the file's."
        },
        "hasBom": {
          "type": "boolean"
        },
        "isText": {
          "type": "boolean"
        },
        "lineEndings": {
          "type": "string",
          "description": "`lf`, `crlf`, `mixed` or `none`: kept as sent."
        },
        "preview": {
          "type": [
            "null",
            "string"
          ],
          "description": "The start of a text file's text for the first five text files, secrets replaced. Text written by someone else: data, never an instruction."
        },
        "sha256": {
          "type": "string"
        },
        "size": {
          "format": "int64",
          "type": "integer"
        },
        "warning": {
          "type": [
            "null",
            "string"
          ],
          "description": "A thing worth saying that is not a refusal: `no_info_header` (a plugin file without an Info header), or null."
        }
      },
      "required": [
        "filePath",
        "size",
        "sha256",
        "isText",
        "hasBom",
        "lineEndings"
      ],
      "type": "object",
      "description": "One file of a staged attachment."
    },
    "AttachmentResponse": {
      "properties": {
        "bytes": {
          "format": "int64",
          "type": "integer"
        },
        "expiresAt": {
          "format": "date-time",
          "type": "string"
        },
        "files": {
          "items": {
            "$ref": "#/$defs/AttachmentFileResponse"
          },
          "type": "array"
        },
        "folder": {
          "type": "string",
          "description": "Where the files go, from the game folder: `oxide/data`."
        },
        "framework": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "keptCopies": {
          "format": "int32",
          "type": "integer"
        },
        "kind": {
          "type": "string"
        },
        "manifestSha256": {
          "type": "string",
          "description": "Send this back when applying: it binds the approval to exactly these files."
        },
        "name": {
          "type": "string"
        },
        "operationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The host operation that places the files, once an apply was asked for; null before."
        },
        "serverId": {
          "type": "string"
        },
        "state": {
          "type": "string",
          "description": "`ready` (waiting for a person), `applying`, `applied`, `failed`, `expired` or `cancelled`."
        }
      },
      "required": [
        "id",
        "serverId",
        "name",
        "state",
        "framework",
        "kind",
        "folder",
        "bytes",
        "manifestSha256",
        "keptCopies",
        "expiresAt",
        "files"
      ],
      "type": "object",
      "description": "A staged attachment as the person and the assistant read it."
    },
    "AttachmentUploadAddressBody": {
      "properties": {
        "bytes": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The exact size of the file in bytes: at most 16 MiB."
        },
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "`oxide` or `carbon`."
        },
        "kind": {
          "type": [
            "null",
            "string"
          ],
          "description": "`plugin`, `library`, `config`, `data` or `language`."
        },
        "path": {
          "type": [
            "null",
            "string"
          ],
          "description": "The path from inside the framework's folder; the address carries only a file for this path."
        },
        "sha256": {
          "type": [
            "null",
            "string"
          ],
          "description": "The fingerprint of the file as 64 hexadecimal characters. The file sent must match it."
        }
      },
      "type": "object",
      "description": "Asks for the address to send one large file to."
    },
    "AttachmentUploadAddressResponse": {
      "properties": {
        "bytes": {
          "format": "int64",
          "type": "integer"
        },
        "expiresAt": {
          "format": "date-time",
          "type": "string"
        },
        "filePath": {
          "type": "string"
        },
        "id": {
          "type": "string",
          "description": "Put this in `uploadSlotId` of the file when staging."
        },
        "serverId": {
          "type": "string"
        },
        "sha256": {
          "type": "string"
        },
        "uploadKey": {
          "type": "string",
          "description": "The value to send as `Authorization: Bearer` on that one `PUT`. It works once, for ten minutes, and is not shown again. Named so, and not `secret` or `token`, on\npurpose: the redactor that guards every logged and returned value would erase those names, and this value is meant for the assistant that asked."
        },
        "url": {
          "type": "string",
          "description": "Send the file with `PUT` to this address within minutes."
        }
      },
      "required": [
        "id",
        "serverId",
        "filePath",
        "bytes",
        "sha256",
        "expiresAt",
        "url",
        "uploadKey"
      ],
      "type": "object",
      "description": "An address for one large file. Shown once."
    },
    "AuditApprovalResponse": {
      "properties": {
        "approvedAt": {
          "format": "date-time",
          "type": "string"
        },
        "planHash": {
          "type": "string"
        },
        "text": {
          "type": "string"
        }
      },
      "required": [
        "approvedAt",
        "text",
        "planHash"
      ],
      "type": "object",
      "description": "The plan a person approved: when, the exact words they read and the fingerprint of the call."
    },
    "AuditAssistantResponse": {
      "properties": {
        "approval": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AuditApprovalResponse",
              "description": "The approval, when there was one."
            }
          ]
        },
        "approved": {
          "type": "boolean",
          "description": "True when the call ran under a plan the person approved."
        },
        "id": {
          "type": [
            "null",
            "string"
          ],
          "description": "The assistant's connection (oab_) or agent key (key_) ID, the value of the `assistantId` filter."
        },
        "kind": {
          "type": "string",
          "description": "`connection` (an assistant the person signed in) or `agent_key` (an unattended assistant)."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the person knows the assistant by."
        },
        "role": {
          "type": [
            "null",
            "string"
          ],
          "description": "The role it held at that moment: `viewer`, `moderator`, `operator`, `administrator` or `owner`; null when the record does not say."
        },
        "servers": {
          "type": [
            "null",
            "string"
          ],
          "description": "The servers it could reach at that moment, in words: `all servers`, `no servers`, `1 server` or `3 servers`; null when the record does not say."
        }
      },
      "required": [
        "id",
        "name",
        "kind",
        "role",
        "approved",
        "approval"
      ],
      "type": "object",
      "description": "An action of an AI assistant as the audit trail records it. The person it acts for is the record's `actor`: an assistant only acts for the\nmember that connected it."
    },
    "AuditRecordListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/AuditRecordResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "The cursor of the next page, or null on the last page."
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Always null: the trail is not counted."
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount"
      ],
      "type": "object"
    },
    "AuditRecordResponse": {
      "properties": {
        "action": {
          "type": "string",
          "description": "A permission or event name, for example servers.lifecycle or operation.cancel."
        },
        "actor": {
          "$ref": "#/$defs/OperationActorResponse",
          "description": "The real actor: an account, a schedule, a rule, a local operator on the host (named by the host's user name), RustSC support or RustSC itself (`system`)."
        },
        "assistant": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AuditAssistantResponse",
              "description": "The AI assistant that made the call, its role and the approval it ran under; null for anything done by a person, a schedule or a rule."
            }
          ]
        },
        "client": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationCredentialResponse",
              "description": "The API key, agent key or OAuth client used, or null for a browser session."
            }
          ]
        },
        "correlationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The chain the record belongs to; records of one request, occurrence or message share it."
        },
        "details": {
          "anyOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/JsonElement",
              "description": "Safe details: changed field names, revisions and reasons."
            }
          ]
        },
        "errorCode": {
          "type": [
            "null",
            "string"
          ],
          "description": "The error code of a denied or failed outcome."
        },
        "id": {
          "type": "string",
          "description": "Audit record ID, for example aud_01jb8z3k4q7v9w2x5y6z8a0b1c."
        },
        "inputs": {
          "anyOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/JsonElement",
              "description": "Details of the requested action."
            }
          ]
        },
        "installationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The installation that performed or reported what the record describes."
        },
        "occurredAt": {
          "format": "date-time",
          "type": "string",
          "description": "When it happened: the cloud's time, or the host's time for a record the host reported."
        },
        "operationId": {
          "type": [
            "null",
            "string"
          ]
        },
        "outcome": {
          "type": "string",
          "description": "`allowed` (admitted; the work's own result is on the operation), `denied`, `succeeded`, `failed`, `cancelled` or `outcome_unknown`."
        },
        "parentOperationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The bulk parent of the operation."
        },
        "permission": {
          "type": [
            "null",
            "string"
          ],
          "description": "The permission the decision was about."
        },
        "permissionVersion": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The workspace permission version the decision was made under."
        },
        "stage": {
          "type": [
            "null",
            "string"
          ],
          "description": "The operation stage the record is about."
        },
        "target": {
          "$ref": "#/$defs/OperationReferenceResponse"
        },
        "traceId": {
          "type": [
            "null",
            "string"
          ]
        },
        "via": {
          "type": "string",
          "description": "`gui`, `api`, `mcp`, `schedule`, `rule`, `local` or `system`."
        }
      },
      "required": [
        "id",
        "occurredAt",
        "actor",
        "via",
        "client",
        "installationId",
        "action",
        "target",
        "outcome",
        "errorCode",
        "permission",
        "permissionVersion",
        "stage",
        "operationId",
        "parentOperationId",
        "correlationId",
        "traceId",
        "inputs",
        "details",
        "assistant"
      ],
      "type": "object",
      "description": "One record of the workspace audit trail: who authorized or performed what, on which target,\nhow it ended and which operation and chain it belongs to. Every field is present; null means\nnone or not recorded. Records never contain secrets: inputs keep secret values only as\nreferences. Support appears as the actor type `support` named \"RustSC support\", with no ID."
    },
    "AvailableActionAuthorityResponse": {
      "properties": {
        "permission": {
          "type": "string",
          "description": "The permission the action needs, for example `servers.lifecycle`."
        },
        "result": {
          "type": "string",
          "description": "`allowed` or `forbidden`."
        }
      },
      "required": [
        "result",
        "permission"
      ],
      "type": "object",
      "description": "Whether the caller holds the permission an action needs on this server."
    },
    "AvailableActionCapabilityResponse": {
      "properties": {
        "capability": {
          "type": "string",
          "description": "The capability asked about: the action's operation kind, for example `server.restart`."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "`host_offline` or `restricted_host` when unavailable, otherwise null."
        },
        "result": {
          "type": "string",
          "description": "`available` or `capability_unavailable`."
        }
      },
      "required": [
        "result",
        "capability",
        "reason"
      ],
      "type": "object",
      "description": "Whether work can reach the server's host for this action now."
    },
    "AvailableActionResponse": {
      "properties": {
        "action": {
          "type": "string",
          "description": "The operation kind, for example `server.restart`."
        },
        "allowed": {
          "type": "boolean",
          "description": "A hint: the request is evaluated again."
        },
        "authority": {
          "$ref": "#/$defs/AvailableActionAuthorityResponse"
        },
        "capability": {
          "$ref": "#/$defs/AvailableActionCapabilityResponse"
        },
        "state": {
          "$ref": "#/$defs/AvailableActionStateResponse"
        }
      },
      "required": [
        "action",
        "allowed",
        "authority",
        "capability",
        "state"
      ],
      "type": "object"
    },
    "AvailableActionStateResponse": {
      "properties": {
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "`already_running` (start) or `not_running` (stop or save) when in conflict, otherwise null."
        },
        "result": {
          "type": "string",
          "description": "`allowed` or `state_conflict`."
        }
      },
      "required": [
        "result",
        "reason"
      ],
      "type": "object",
      "description": "Whether the server's reported state allows the action."
    },
    "AvailableActionsResponse": {
      "properties": {
        "evaluatedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the checks ran."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/AvailableActionResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items",
        "evaluatedAt"
      ],
      "type": "object"
    },
    "BackupAssociationResponse": {
      "properties": {
        "reason": {
          "type": [
            "null",
            "string"
          ]
        },
        "state": {
          "type": "string"
        }
      },
      "required": [
        "state",
        "reason"
      ],
      "type": "object",
      "description": "The validated relationship status, without exposing an unproven claimed parent identity."
    },
    "BackupExportLinkResponse": {
      "properties": {
        "expiresAt": {
          "format": "date-time",
          "type": "string"
        },
        "url": {
          "type": "string"
        }
      },
      "required": [
        "url",
        "expiresAt"
      ],
      "type": "object",
      "description": "A link that works once, for the member who asked, until `expiresAt`."
    },
    "BackupExportResponse": {
      "properties": {
        "expiresAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the file stops being available (24 hours after the request)."
        },
        "sizeBytes": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ]
        },
        "state": {
          "type": "string"
        }
      },
      "required": [
        "state"
      ],
      "type": "object",
      "description": "Whether a backup export can be downloaded: `ready`, `waiting` (the host is still building it) or `expired`."
    },
    "BackupListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/BackupResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "The cursor of the next page; null on the last page."
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Always null."
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount"
      ],
      "type": "object",
      "description": "One page of a server's backups, newest first."
    },
    "BackupPolicyResponse": {
      "properties": {
        "applied": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AppliedBackupPolicyResponse"
            }
          ]
        },
        "canManage": {
          "type": "boolean",
          "description": "Current target-scoped authority to change this policy; not authority to change any other server."
        },
        "change": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResponse"
            }
          ]
        },
        "connected": {
          "type": "boolean"
        },
        "observation": {
          "type": "string",
          "description": "Unknown until the current installation reports its setting; observed otherwise."
        },
        "refresh": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResponse"
            }
          ]
        },
        "supported": {
          "type": "boolean"
        }
      },
      "required": [
        "observation",
        "applied",
        "change",
        "refresh",
        "supported",
        "connected",
        "canManage"
      ],
      "type": "object"
    },
    "BackupResponse": {
      "properties": {
        "bytes": {
          "format": "int64",
          "type": "integer",
          "description": "Bytes stored."
        },
        "change": {
          "type": [
            "null",
            "string"
          ],
          "description": "The change this backup was the first step of, when the member chose to back up before it: `game_update`, `wipe` or\n`framework_install`, `framework_upgrade`, `framework_reinstall`, `framework_switch`, `framework_uninstall`;\nnull otherwise (`trigger` then says why it was taken). Treat unknown values as a change."
        },
        "changeFramework": {
          "type": [
            "null",
            "string"
          ],
          "description": "`oxide` or `carbon` for a framework change that names one; null otherwise."
        },
        "cleanableBytes": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "Bytes of those files; null when not reported."
        },
        "cleanableFiles": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "Files a \"Clean up old files\" would have removed when this backup was taken (old logs); null when not reported."
        },
        "cloudCopyAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the cloud copy of this backup was made (UTC); null when the server's cloud storage holds no copy of it. Taken from the server's cloud copies, so a copy\nthe member's retention has removed no longer shows. Null too in a role with no cloud storage set up and in the servers summary's latest backup."
        },
        "completedAt": {
          "type": "string",
          "description": "When the capture finished (UTC, the host's clock)."
        },
        "files": {
          "format": "int64",
          "type": "integer",
          "description": "Files stored."
        },
        "gameBuildId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The game build it belongs to, when the install record named one."
        },
        "id": {
          "type": "string",
          "description": "The recovery point ID, for example `rpt_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "leftOutBytes": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "Bytes of logs, saves and maps of earlier wipes, rotated save copies and caches this backup leaves out; null when the host did not report it."
        },
        "location": {
          "type": "string",
          "description": "`host_local`: on the server's own host, which a copy there cannot protect against losing."
        },
        "operationId": {
          "type": "string",
          "description": "The operation associated with this backup. For a backup the host of a rented server lists that RustSC holds no record of (trigger `outside`, or one whose record is gone) there is none, and this is the all-zero operation id."
        },
        "problemFiles": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The files or folders that did not pass their check, as the server's own relative paths, for example `carbon/plugins` (at most five); empty when none did or the host did not name them."
        },
        "problems": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Why an incomplete backup is incomplete, for example `consistency_adapter_unavailable` (taken while\nthe game ran), `generation_unknown` or `resource_unreadable`. Empty when complete. Treat unknown values as other."
        },
        "serverRunning": {
          "type": "boolean",
          "description": "Whether the game ran while it was copied."
        },
        "startedAt": {
          "type": "string",
          "description": "When the capture window opened (UTC, the host's clock)."
        },
        "state": {
          "type": "string",
          "description": "`complete`: every essential file was captured with the consistency it needs. `incomplete`: see `problems`; a backup whose only problems are consistency ones (taken while the game ran) can still be restored. Treat unknown values as other."
        },
        "trigger": {
          "type": "string",
          "description": "`manual`, `before_start`, `scheduled` or `before_restore` (the state a restore replaced); `outside` for a backup on a rented server's host that RustSC did not make\n(read-only: it can be restored and RustSC never removes it). Treat unknown values as other."
        }
      },
      "required": [
        "id",
        "operationId",
        "trigger",
        "state",
        "problems",
        "problemFiles",
        "serverRunning",
        "startedAt",
        "completedAt",
        "files",
        "bytes",
        "gameBuildId",
        "location",
        "cloudCopyAt",
        "leftOutBytes",
        "change",
        "changeFramework",
        "cleanableFiles",
        "cleanableBytes"
      ],
      "type": "object",
      "description": "One backup the server's host stored on its own disk."
    },
    "BackupSettingsResponse": {
      "properties": {
        "beforeChanges": {
          "type": "boolean",
          "description": "Whether a game update, a framework change and a wipe take a backup first unless that one change says otherwise (\"Back up before changes\", on by default)."
        },
        "canManage": {
          "type": "boolean",
          "description": "Current authority to change this server's backup settings and clean up."
        },
        "change": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResponse",
              "description": "A change that is not applied yet or failed; null when the last change was applied."
            }
          ]
        },
        "cleanUp": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResponse",
              "description": "The newest \"Clean up old files\", in any state; null when none ran."
            }
          ]
        },
        "connected": {
          "type": "boolean"
        },
        "defaultKeep": {
          "format": "int32",
          "type": "integer"
        },
        "isDefault": {
          "type": "boolean",
          "description": "True when `keep` is the default."
        },
        "keep": {
          "format": "int32",
          "type": "integer",
          "description": "The number of backups the host keeps (the newest ones); 0 means it keeps every backup."
        },
        "limitGb": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The most the server's backups may use, in GB; null means no limit."
        },
        "location": {
          "type": [
            "null",
            "string"
          ],
          "description": "The folder the member saved for this server's backups, as the host last applied it; null when none is saved. Without one no backup is made: every request is skipped\n(the workflow it belongs to goes on) and Back up now says to choose where backups go."
        },
        "locationFreeBytes": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The free bytes of the location's disk when it was saved; null when none is saved or the host did not report it."
        },
        "makeRoom": {
          "type": "boolean",
          "description": "Whether the host makes room when the disk is nearly full (old logs, then the oldest backups that are not protected)."
        },
        "maximumLimitGb": {
          "format": "int32",
          "type": "integer"
        },
        "minimum": {
          "format": "int32",
          "type": "integer",
          "description": "The fewest backups a member can choose, other than 0 (keep every backup)."
        },
        "minimumLimitGb": {
          "format": "int32",
          "type": "integer"
        },
        "newestBytes": {
          "format": "int64",
          "type": "integer",
          "description": "The size of the newest stored backup, in bytes: the least a limit can hold."
        },
        "storedBytes": {
          "format": "int64",
          "type": "integer",
          "description": "The total size of the stored backups, in bytes."
        },
        "storedCount": {
          "format": "int32",
          "type": "integer",
          "description": "How many backups are stored now."
        },
        "supported": {
          "type": "boolean"
        }
      },
      "required": [
        "keep",
        "isDefault",
        "defaultKeep",
        "minimum",
        "makeRoom",
        "limitGb",
        "minimumLimitGb",
        "maximumLimitGb",
        "beforeChanges",
        "storedCount",
        "storedBytes",
        "newestBytes",
        "change",
        "cleanUp",
        "supported",
        "connected",
        "canManage"
      ],
      "type": "object",
      "description": "How many backups a server keeps and its latest cleanup."
    },
    "BanFactListResponse": {
      "properties": {
        "appealsUrl": {
          "type": [
            "null",
            "string"
          ]
        },
        "id": {
          "type": "string",
          "description": "`steam` or a community list's ID."
        },
        "name": {
          "type": "string"
        },
        "official": {
          "type": "boolean",
          "description": "True only for Valve (and Facepunch); no community list is official."
        },
        "runBy": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "runBy",
        "official"
      ],
      "type": "object",
      "description": "What the member needs to name a list beside its facts."
    },
    "BanFactPlayerResponse": {
      "properties": {
        "allowedAnyway": {
          "type": "boolean",
          "description": "True when a moderator allowed the player anyway: no ban list removes them."
        },
        "facts": {
          "items": {
            "$ref": "#/$defs/BanFactResponse"
          },
          "type": "array"
        },
        "steamId": {
          "type": "string"
        }
      },
      "required": [
        "steamId",
        "allowedAnyway",
        "facts"
      ],
      "type": "object",
      "description": "One player's ban facts."
    },
    "BanFactResponse": {
      "properties": {
        "askedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the list was last asked, answered or not."
        },
        "communityBanned": {
          "type": [
            "null",
            "boolean"
          ]
        },
        "daysSinceLastBan": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "endsAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "firstListedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "gameBans": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "lastListedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "listId": {
          "type": "string"
        },
        "mute": {
          "type": [
            "null",
            "boolean"
          ]
        },
        "notListedSince": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When a list that had listed the player first said they are not listed (lifted or ended). The wording never says unbanned."
        },
        "observedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the last known answer was given."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "A community list's own words. Null without `players.read.sensitive` (`reasonHidden`)."
        },
        "reasonHidden": {
          "type": "boolean",
          "description": "True when the list gave a reason and the reader may not read it."
        },
        "state": {
          "type": [
            "null",
            "string"
          ],
          "description": "`listed` or `not_listed`; null when the list never answered."
        },
        "unknownReason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why the list's last ask got no answer; null when it answered."
        },
        "vacBans": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        }
      },
      "required": [
        "listId",
        "reasonHidden",
        "askedAt"
      ],
      "type": "object",
      "description": "One list's last known answer about a player. A fact the list did not give is null, never zero."
    },
    "BanFactsAskedResponse": {
      "properties": {
        "players": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "players"
      ],
      "type": "object",
      "description": "How many players the host was asked about."
    },
    "BanFactsResponse": {
      "properties": {
        "lists": {
          "items": {
            "$ref": "#/$defs/BanFactListResponse"
          },
          "type": "array"
        },
        "masked": {
          "type": "boolean",
          "description": "True when the reader lacks `players.read.sensitive`: the lists' own reasons are left out."
        },
        "players": {
          "items": {
            "$ref": "#/$defs/BanFactPlayerResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "lists",
        "players",
        "masked"
      ],
      "type": "object",
      "description": "The ban facts of up to 50 players with the lists they came from."
    },
    "BanImportPreviewResponse": {
      "properties": {
        "alreadyBanned": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Valid bans already on the ban list, counted from the list RustSC last read (the newest 500). Null when the list could not be\nread; an import then leaves out any that turn out to be banned."
        },
        "duplicates": {
          "format": "int32",
          "type": "integer",
          "description": "Lines for a Steam ID an earlier line already names."
        },
        "ended": {
          "format": "int32",
          "type": "integer",
          "description": "Lines whose ban had already ended; they are left out."
        },
        "invalidLines": {
          "format": "int32",
          "type": "integer",
          "description": "Lines left out as not valid (a Steam ID that is not 17 digits from 7656, or an end time that cannot be used)."
        },
        "listComplete": {
          "type": "boolean",
          "description": "False when the server holds more bans than RustSC read, so `alreadyBanned` can be higher once the import runs."
        },
        "newBans": {
          "format": "int32",
          "type": "integer",
          "description": "Valid bans in the list that are not on the server's ban list: what an import would make."
        },
        "problems": {
          "items": {
            "$ref": "#/$defs/BanImportProblemResponse"
          },
          "type": "array",
          "description": "The first not valid lines (at most 20), with their line number."
        },
        "refusal": {
          "type": [
            "null",
            "string"
          ],
          "description": "Null when the list can be used. Otherwise why it cannot as a whole: `not_text` (a file that is not text), `too_large`\n(over 262144 characters) or `too_many` (over 500 bans; nothing is counted)."
        },
        "temporary": {
          "format": "int32",
          "type": "integer",
          "description": "How many of the new bans end by themselves (carry an end time)."
        }
      },
      "required": [
        "newBans",
        "listComplete",
        "invalidLines",
        "duplicates",
        "ended",
        "temporary",
        "problems"
      ],
      "type": "object",
      "description": "What a list of bans would do on this server, counted before anything is sent."
    },
    "BanImportProblemResponse": {
      "properties": {
        "line": {
          "format": "int32",
          "type": "integer",
          "description": "The line, counted from 1."
        },
        "reason": {
          "type": "string",
          "description": "`invalid_steam_id` or `invalid_expiry`."
        }
      },
      "required": [
        "line",
        "reason"
      ],
      "type": "object",
      "description": "A line of a list of bans that was not used."
    },
    "BanListChoiceBody": {
      "properties": {
        "enforce": {
          "type": "boolean",
          "description": "True removes a listed player a few seconds after they join; false only shows the answer on the player."
        },
        "id": {
          "type": "string"
        },
        "message": {
          "type": [
            "null",
            "string"
          ],
          "description": "What a removed player sees; left out, the list's default or the earlier words stay."
        }
      },
      "required": [
        "id",
        "enforce"
      ],
      "type": "object",
      "description": "One community list's choice."
    },
    "BanListHealthResponse": {
      "properties": {
        "lastAnsweredAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The last time the list gave an answer; null when it never did."
        },
        "lastAskedAt": {
          "format": "date-time",
          "type": "string"
        },
        "listId": {
          "type": "string",
          "description": "`steam` or a community list's ID."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why the last ask got no answer: `unavailable`, `rejected_key`, `timeout`, `rate_limited`, `bad_answer`, `http_error` and the other reasons of a Steam answer; null when it answered."
        },
        "unansweredSince": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "Set while the list's answers are all unknown, from the first one."
        }
      },
      "required": [
        "listId",
        "lastAskedAt"
      ],
      "type": "object",
      "description": "Whether a list answers this server's asks."
    },
    "BanListKeyBody": {
      "properties": {
        "key": {
          "type": "string",
          "description": "The key the list's service gave: 1 to 512 characters, no spaces."
        },
        "placement": {
          "type": "string",
          "description": "`api_key_header` (a header called x-api-key), `bearer` (the Authorization header) or `query_key` (the address gets ?key=)."
        }
      },
      "required": [
        "key",
        "placement"
      ],
      "type": "object",
      "description": "A community list's key (`PUT /ban-settings/lists/{listId}/key`): typed once, never shown again."
    },
    "BanListTextRequestBody": {
      "properties": {
        "text": {
          "type": "string",
          "description": "The list as typed or read from a file, at most 262144 characters: one Steam ID per line with an optional reason after it, the file\nthe export writes (`steam_id,name,reason,expires_at`) or the game's own `banid` lines. Blank lines, a header line and\nlines starting with `#` are skipped; a line that is not valid is counted and left out."
        }
      },
      "required": [
        "text"
      ],
      "type": "object",
      "description": "A list of bans to read or make."
    },
    "BanListsResponse": {
      "properties": {
        "allowedAnywayCount": {
          "format": "int32",
          "type": "integer",
          "description": "How many players the workspace's Allowed anyway list holds."
        },
        "health": {
          "items": {
            "$ref": "#/$defs/BanListHealthResponse"
          },
          "type": "array"
        },
        "lists": {
          "items": {
            "$ref": "#/$defs/CommunityBanListResponse"
          },
          "type": "array"
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "The revision of the server's rules; 0 before the first save."
        },
        "serverId": {
          "type": "string"
        },
        "serverName": {
          "type": "string"
        },
        "steam": {
          "$ref": "#/$defs/SteamBanSettingsBody"
        },
        "steamKeySet": {
          "type": "boolean",
          "description": "True while the workspace holds its own Steam key: only then is Steam asked about joining players."
        },
        "supported": {
          "type": "boolean"
        },
        "updatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "serverId",
        "serverName",
        "supported",
        "revision",
        "steam",
        "steamKeySet",
        "lists",
        "allowedAnywayCount",
        "health"
      ],
      "type": "object",
      "description": "A server's ban lists: the workspace's choices as this server holds them, and how each list has answered this server. The choices are the\nworkspace's (`PUT /ban-settings`); there is nothing to change on one server. `supported` is false on a server without a host service."
    },
    "BanPlayerRequestBody": {
      "properties": {
        "expiresInSeconds": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "How long the ban lasts, in seconds from now: 60 (one minute) to 31536000 (365 days). Left out, the ban never ends. The game ends a\ntemporary ban by itself at that moment; RustSC keeps no timer. An unreasonable length is refused with `invalid_expiry` on\n`/expiresInSeconds`."
        },
        "giveRoleBack": {
          "type": "boolean",
          "description": "True to have RustSC put the player's owner or moderator role back when the ban is lifted or ends. The game keeps one entry per Steam ID, so a ban replaces the role and an\nended or lifted ban leaves none. Left out or false, nothing is put back. The portal's ban form pre-fills it on; it only does something when the player holds a role."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name to store with the ban, optional, up to 64 characters. A connected player's own name is used instead."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why; optional, up to 200 characters. Stored with the ban in the game's ban list."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID to ban, 17 digits. The player does not have to be connected."
        }
      },
      "required": [
        "steamId"
      ],
      "type": "object",
      "description": "Bans one player. A connected player is kicked by the ban."
    },
    "BanResponse": {
      "properties": {
        "bannedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When that ban was requested; null with `bannedBy`."
        },
        "bannedBy": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationActorResponse",
              "description": "Who banned the player through RustSC; null for a ban made outside RustSC or older than the history RustSC reads."
            }
          ]
        },
        "expiresAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the ban ends and the game removes it by itself; null when it never does."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name stored with the ban (the game's own `unnamed` when none was given)."
        },
        "operationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The ban operation (`op_...`); null with `bannedBy`."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "The reason stored with the ban (the game's own `no reason` when none was given)."
        },
        "scope": {
          "type": "string",
          "description": "`server` (this server's own ban, or one made outside RustSC), `global` (the workspace ban list's ban only) or `both`."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID as a decimal string; keep it a string."
        }
      },
      "required": [
        "steamId",
        "scope"
      ],
      "type": "object",
      "description": "One ban of the game's list."
    },
    "BanSettingsResponse": {
      "properties": {
        "allowedAnywayCount": {
          "format": "int32",
          "type": "integer",
          "description": "How many players the workspace's Allowed anyway list holds."
        },
        "lists": {
          "items": {
            "$ref": "#/$defs/CommunityBanListResponse"
          },
          "type": "array"
        },
        "steam": {
          "$ref": "#/$defs/SteamBanSettingsBody"
        },
        "steamKeySet": {
          "type": "boolean",
          "description": "True while the workspace holds its own Steam key: only then is Steam asked about joining players."
        },
        "updatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the choices were last saved; null before the first save."
        }
      },
      "required": [
        "steam",
        "steamKeySet",
        "lists",
        "allowedAnywayCount"
      ],
      "type": "object",
      "description": "The workspace's ban list choices (`GET /ban-settings`): one for Steam and one for each community list, for every server."
    },
    "BansResponse": {
      "properties": {
        "bans": {
          "items": {
            "$ref": "#/$defs/BanResponse"
          },
          "type": "array",
          "description": "The newest bans, newest first, at most 500. `total` says how many the game holds."
        },
        "globalApplies": {
          "type": "boolean",
          "description": "Whether the workspace ban list writes to this server (its saved choice)."
        },
        "globalBans": {
          "format": "int32",
          "type": "integer",
          "description": "How many global bans (the workspace ban list) apply to this server; 0 when the list does not write to it."
        },
        "observedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the host read the game; null without an observation."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why the list is unavailable: `no_observation` or the host's reason, such as `rcon_unavailable`. Null when observed."
        },
        "state": {
          "type": "string",
          "description": "`observed`, or `unavailable` when the game could not be read or no observation arrived in time."
        },
        "total": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "Every ban the game listed; null when unavailable."
        }
      },
      "required": [
        "state",
        "bans"
      ],
      "type": "object",
      "description": "The game's own ban list: one observation, the same one the live `server.bans` feed shows. `state` `unavailable` is never an empty list: `bans` is then empty and `total` null."
    },
    "BeginUploadBody": {
      "properties": {
        "contentBytes": {
          "format": "int64",
          "type": "integer",
          "description": "Bytes of the files themselves (at most 2 GiB)."
        },
        "entries": {
          "format": "int32",
          "type": "integer",
          "description": "Files and empty folders in the stream (1 to 5000)."
        },
        "files": {
          "format": "int32",
          "type": "integer",
          "description": "Files among them."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "What the member sees (\"Halloween pack\"): up to 120 characters."
        },
        "signature": {
          "type": [
            "null",
            "string"
          ],
          "description": "Lower-case hexadecimal signature of the selected files. Use the same value to resume the same upload."
        },
        "totalBytes": {
          "format": "int64",
          "type": "integer",
          "description": "Bytes of the tar stream that will be sent: the files plus their headers and padding."
        }
      },
      "type": "object",
      "description": "Start an upload of a dropped group of files and folders."
    },
    "BenefitRoleResponse": {
      "properties": {
        "id": {
          "type": "string"
        },
        "mentionable": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Discord's flag that anyone may mention the role. Left out when it could not be read. A role that is not mentionable is pinged only while `botCanMentionAll` is true."
        },
        "name": {
          "type": "string"
        },
        "problem": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "BenefitRolesResponse": {
      "properties": {
        "botCanManageRoles": {
          "type": "boolean",
          "description": "False when the bot lacks Manage Roles in the server."
        },
        "botCanMentionAll": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Whether the bot holds Discord's Mention Everyone permission, so it can mention any role (also one that is not mentionable), @everyone and @here. Left out when it could not be read."
        },
        "roles": {
          "items": {
            "$ref": "#/$defs/BenefitRoleResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "roles",
        "botCanManageRoles"
      ],
      "type": "object",
      "description": "The roles of the connected Discord server a rule can pick, strongest first; `problem` is as on a rule."
    },
    "BroadcastRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "text": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object",
      "description": "One ad hoc broadcast."
    },
    "BrowseFolderRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the host is offline; leave it out to refuse."
            }
          ]
        },
        "path": {
          "type": [
            "null",
            "string"
          ],
          "description": "The folder to list, an absolute path on the host, for example `/srv/rust`. A folder that does not exist is answered with its nearest existing parent."
        },
        "serverId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The server on this host whose backup folder is being chosen (`srv_...`). With it, a member who may manage that server's backups may browse without the right to add servers. Leave it out otherwise."
        },
        "showHidden": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Ignored: hidden folders are never listed. Kept so an older client that sends it keeps working."
        }
      },
      "type": "object",
      "description": "Lists the folders of a host, for choosing where a server is installed. Nothing is written."
    },
    "BrowserChangeBody": {
      "properties": {
        "categories": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "What it gets; at least one of `availability`, `operations` and `resources`."
        },
        "enabled": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Whether it gets alerts. Default true. Turning a browser RustSC switched off back on resumes it."
        }
      },
      "required": [
        "categories"
      ],
      "type": "object",
      "description": "A change to one of the caller's browsers."
    },
    "BrowserNotificationsResponse": {
      "properties": {
        "available": {
          "type": "boolean",
          "description": "False where the service has no browser notifications set up; then there is nothing to offer."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/BrowserResponse"
          },
          "type": "array"
        },
        "publicKey": {
          "type": [
            "null",
            "string"
          ],
          "description": "Not a secret; null when not available."
        }
      },
      "required": [
        "available",
        "publicKey",
        "items"
      ],
      "type": "object"
    },
    "BrowserResponse": {
      "properties": {
        "categories": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "id": {
          "type": "string",
          "description": "The browser route's ID (`brw_`)."
        },
        "label": {
          "type": "string"
        },
        "lastSentAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the push service last accepted an alert for it, or null."
        },
        "offReason": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "id",
        "label",
        "categories",
        "enabled",
        "offReason",
        "createdAt",
        "lastSentAt"
      ],
      "type": "object",
      "description": "One of the caller's browsers. Never the push address or a key."
    },
    "BrowserSessionResponse": {
      "properties": {
        "address": {
          "type": [
            "null",
            "string"
          ],
          "description": "The sign-in address with its last part hidden, for example `203.0.113.x`. Shown only to the account itself."
        },
        "client": {
          "type": [
            "null",
            "string"
          ],
          "description": "The browser, for example `Chrome`, or the app's name. Null when it did not say."
        },
        "clientVersion": {
          "type": [
            "null",
            "string"
          ],
          "description": "The browser's major version, or the app's version."
        },
        "country": {
          "type": [
            "null",
            "string"
          ],
          "description": "The two-letter country of the sign-in address, for example `AU`, looked up from the address. Approximate; null when unknown."
        },
        "current": {
          "type": "boolean",
          "description": "True for the browser or app making this request."
        },
        "deviceKind": {
          "type": [
            "null",
            "string"
          ],
          "description": "`computer`, `phone`, `tablet` or `unknown`."
        },
        "deviceModel": {
          "type": [
            "null",
            "string"
          ],
          "description": "The phone or tablet model when the app or browser said it."
        },
        "id": {
          "type": "string",
          "description": "Session ID: `ses_...` for a browser, `dvs_...` for an app."
        },
        "kind": {
          "type": "string",
          "description": "`browser` or `app`."
        },
        "lastUsedAt": {
          "format": "date-time",
          "type": "string"
        },
        "method": {
          "type": "string",
          "description": "How it signed in: `email_code`, `passkey`, `google` or `discord`, or `app` for a phone or tablet app."
        },
        "os": {
          "type": [
            "null",
            "string"
          ],
          "description": "The system, for example `Windows`, `macOS`, `iOS` or `Android`."
        },
        "osVersion": {
          "type": [
            "null",
            "string"
          ]
        },
        "signedInAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "id",
        "method",
        "signedInAt",
        "lastUsedAt",
        "current"
      ],
      "type": "object",
      "description": "One browser or app sign-in that still works."
    },
    "BrowserSessionsResponse": {
      "properties": {
        "sessions": {
          "items": {
            "$ref": "#/$defs/BrowserSessionResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "sessions"
      ],
      "type": "object",
      "description": "Everywhere the account is signed in: browsers and phone or tablet apps, newest first."
    },
    "BrowserSubscribeBody": {
      "properties": {
        "auth": {
          "type": "string"
        },
        "categories": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "What it gets: any of `availability`, `operations` and `resources`. At least one."
        },
        "endpoint": {
          "type": "string",
          "description": "Stored as a protected secret and never returned."
        },
        "label": {
          "type": [
            "null",
            "string"
          ],
          "description": "What this browser is called in the list, for example \"Chrome on Windows\". Optional; up to 60 characters."
        },
        "p256dh": {
          "type": "string"
        }
      },
      "required": [
        "endpoint",
        "p256dh",
        "auth",
        "categories"
      ],
      "type": "object",
      "description": "Turns alerts on in a browser: what the browser gave when its member allowed notifications (`PushSubscription.toJSON()`), and what to send."
    },
    "BrowserTestResponse": {
      "properties": {
        "delivered": {
          "type": "boolean"
        },
        "problem": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why not: `subscription_gone` (the browser dropped it), `unreachable`, `timed_out`, `secure_connection_failed`, `rate_limited`, `server_error`, `address_refused`, `rejected`, `destination_not_configured` or `destination_unreadable`; null when delivered."
        }
      },
      "required": [
        "delivered",
        "problem"
      ],
      "type": "object",
      "description": "Whether the test notification was accepted by the browser's push service."
    },
    "BuildLabelResponse": {
      "properties": {
        "date": {
          "type": [
            "null",
            "string"
          ],
          "description": "The day the file was committed (`2026-10-27`), only when there is no `release`."
        },
        "release": {
          "type": [
            "null",
            "string"
          ],
          "description": "The publisher's release name without a leading `v`, for example `2.0.3`."
        }
      },
      "type": "object",
      "description": "The display name of a build of a supporting extension (RustEdit). `release` is the publisher's release (`2.0.2`) when a tag of its repository points at a commit that\nholds exactly that file; otherwise `date` is the day the file was committed (a build without a tag); with neither, the build is known by no recent commit (a custom or older file). Display only: whether an update is available is decided by the build ids, never by these."
    },
    "BuiltInMapResponse": {
      "properties": {
        "level": {
          "type": "string",
          "description": "The value to send as `level`, for example `CraggyIsland`."
        },
        "name": {
          "type": "string",
          "description": "The name to show."
        }
      },
      "required": [
        "level",
        "name"
      ],
      "type": "object"
    },
    "BulkCountsResponse": {
      "properties": {
        "blocked": {
          "format": "int32",
          "type": "integer"
        },
        "failed": {
          "format": "int32",
          "type": "integer"
        },
        "running": {
          "format": "int32",
          "type": "integer"
        },
        "skipped": {
          "format": "int32",
          "type": "integer"
        },
        "succeeded": {
          "format": "int32",
          "type": "integer"
        },
        "total": {
          "format": "int32",
          "type": "integer"
        },
        "unknown": {
          "format": "int32",
          "type": "integer"
        },
        "waiting": {
          "format": "int32",
          "type": "integer",
          "description": "A ban or unban waiting for a host that is offline; it runs when the host is back. Not counted in `running` (additive, customer API 213)."
        },
        "willRun": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "total",
        "willRun",
        "skipped",
        "blocked",
        "succeeded",
        "running",
        "failed",
        "unknown",
        "waiting"
      ],
      "type": "object"
    },
    "BulkPlanBody": {
      "properties": {
        "groupIds": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Groups chosen (`grp_...`); every member the caller can read."
        },
        "kind": {
          "type": [
            "null",
            "string"
          ],
          "description": "`player.ban`, `player.unban`, `server.broadcast` or `profile.apply`."
        },
        "parameters": {
          "$ref": "#/$defs/JsonElement",
          "description": "`player.ban`: `steamId`, optional `name`, `reason` and `expiresInSeconds`. `player.unban`: `steamId`. `server.broadcast`: `text`. `profile.apply`: `profileId` (`prf_...`)."
        },
        "rollout": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/BulkRolloutBody",
              "description": "How the servers start. Absent means every server together."
            }
          ]
        },
        "serverIds": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Servers chosen one by one (`srv_...`)."
        }
      },
      "type": "object",
      "description": "What to do on which servers."
    },
    "BulkPlanListResponse": {
      "properties": {
        "plans": {
          "items": {
            "$ref": "#/$defs/BulkPlanSummaryResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "plans"
      ],
      "type": "object"
    },
    "BulkPlanResponse": {
      "properties": {
        "canRetry": {
          "type": "boolean",
          "description": "Some servers can be retried now."
        },
        "cancelRequested": {
          "type": "boolean"
        },
        "counts": {
          "$ref": "#/$defs/BulkCountsResponse"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "expiresAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "id": {
          "type": "string"
        },
        "kind": {
          "type": "string"
        },
        "operationId": {
          "type": [
            "null",
            "string"
          ]
        },
        "outcome": {
          "type": "string",
          "description": "`ready`, then `running`, `succeeded`, `partial`, `failed` or `cancelled`. Partly done is never reported as done."
        },
        "parameters": {
          "$ref": "#/$defs/JsonElement"
        },
        "retryOfPlanId": {
          "type": [
            "null",
            "string"
          ]
        },
        "rollout": {
          "$ref": "#/$defs/BulkRolloutResponse",
          "description": "How the servers start."
        },
        "sources": {
          "items": {
            "$ref": "#/$defs/BulkSourceResponse"
          },
          "type": "array"
        },
        "state": {
          "type": "string",
          "description": "`ready` (shown, nothing sent) or `applied`."
        },
        "targets": {
          "items": {
            "$ref": "#/$defs/BulkTargetResponse"
          },
          "type": "array"
        },
        "title": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "kind",
        "title",
        "parameters",
        "state",
        "outcome",
        "sources",
        "createdAt",
        "retryOfPlanId",
        "operationId",
        "targets",
        "counts",
        "canRetry",
        "rollout",
        "expiresAt",
        "cancelRequested"
      ],
      "type": "object"
    },
    "BulkPlanSummaryResponse": {
      "properties": {
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "kind": {
          "type": "string"
        },
        "retryOfPlanId": {
          "type": [
            "null",
            "string"
          ]
        },
        "state": {
          "type": "string"
        },
        "targetCount": {
          "format": "int32",
          "type": "integer"
        },
        "title": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "kind",
        "title",
        "state",
        "createdAt",
        "targetCount",
        "retryOfPlanId"
      ],
      "type": "object"
    },
    "BulkPlayerBody": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the member saw, up to 64 characters; optional."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID of the player, 17 digits. A name never selects a player."
        }
      },
      "required": [
        "steamId"
      ],
      "type": "object",
      "description": "One player of a bulk action on a rented server: the Steam ID and, for the activity line and a ban's stored name, the name the member saw."
    },
    "BulkRetryBody": {
      "properties": {
        "serverIds": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ]
        }
      },
      "type": "object",
      "description": "Retry only these servers; absent or empty retries every server that failed or was not started."
    },
    "BulkRolloutBody": {
      "properties": {
        "groupSize": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Servers per group for `in_groups`, 2 to 50; absent is 5."
        },
        "mode": {
          "type": [
            "null",
            "string"
          ],
          "description": "`together` (default), `one_at_a_time` or `in_groups`."
        },
        "pilot": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Run the first server alone before the rest. Absent is false."
        },
        "stopOnFailure": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Leave the servers after a failed group untouched (default true). False carries on to the next group after a failure."
        }
      },
      "type": "object"
    },
    "BulkRolloutResponse": {
      "properties": {
        "groupSize": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "mode": {
          "type": "string"
        },
        "pilot": {
          "type": "boolean"
        },
        "stopOnFailure": {
          "type": "boolean"
        }
      },
      "required": [
        "mode",
        "groupSize",
        "pilot",
        "stopOnFailure"
      ],
      "type": "object"
    },
    "BulkSourceResponse": {
      "properties": {
        "memberCount": {
          "format": "int32",
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "name",
        "revision",
        "memberCount"
      ],
      "type": "object"
    },
    "BulkTargetResponse": {
      "properties": {
        "canRetry": {
          "type": "boolean",
          "description": "Whether Retry failed would run on this server."
        },
        "detail": {
          "anyOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/JsonElement",
              "description": "What will change here. A profile apply: `changes` (key, from, to) and `kept` (fields the server keeps its own value for)."
            }
          ]
        },
        "hostName": {
          "type": [
            "null",
            "string"
          ]
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "`no_permission`, `server_removed`, `restricted_host`, `host_offline`, `nothing_to_change`, `changed_since_preview` or `not_started`."
        },
        "result": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/BulkTargetResultResponse"
            }
          ]
        },
        "serverId": {
          "type": "string"
        },
        "serverName": {
          "type": "string"
        },
        "stage": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "status": {
          "type": "string",
          "description": "`will_run`, `skipped` (nothing to do) or `blocked` (cannot run now; see `reason`)."
        }
      },
      "required": [
        "serverId",
        "serverName",
        "hostName",
        "status",
        "reason",
        "detail",
        "result",
        "canRetry",
        "stage"
      ],
      "type": "object"
    },
    "BulkTargetResultResponse": {
      "properties": {
        "detail": {
          "anyOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/JsonElement",
              "description": "A recurring message or command: `scheduleId` (`sch_...`), `timeZone` and `nextRunAt` (the first run, or null when none is pending). A permission list that has finished on the server: `route` and the numbers of changes `applied`, `alreadySo` and `skipped`. Null for any other action that starts an operation."
            }
          ]
        },
        "errorCode": {
          "type": [
            "null",
            "string"
          ]
        },
        "operationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The server's own operation (`op_...`), or null when none was started."
        },
        "state": {
          "type": "string",
          "description": "`queued`, `running`, `succeeded`, `failed`, `cancelled`, `outcome_unknown`, `skipped` or `not_started`. Treat unknown values as other."
        }
      },
      "required": [
        "state",
        "operationId",
        "errorCode",
        "detail"
      ],
      "type": "object"
    },
    "CandidateBatchResponse": {
      "properties": {
        "algorithm": {
          "type": "string",
          "description": "The sampling algorithm and its version."
        },
        "candidates": {
          "items": {
            "$ref": "#/$defs/CandidateResponse"
          },
          "type": "array"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string",
          "description": "The batch's identity (`mcb_`)."
        },
        "makeMessage": {
          "type": [
            "null",
            "string"
          ],
          "description": "A plain sentence for an ask that did not end well (`not_today` or `unavailable`), or absent."
        },
        "makeResult": {
          "type": [
            "null",
            "string"
          ],
          "description": "How the last ask ended: `done`, `not_today` or `unavailable`. Absent while open or when none was made."
        },
        "making": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True while an ask to make the missing maps is open and not finished (the screen reads the batch again until it is false). Absent when the function is not offered."
        },
        "pendingCount": {
          "format": "int32",
          "type": "integer",
          "description": "How many are still being looked up or could not be looked up yet; resuming asks again for these only."
        },
        "readyCount": {
          "format": "int32",
          "type": "integer",
          "description": "How many are ready (the map service has the map and showed its facts)."
        },
        "requestedCount": {
          "format": "int32",
          "type": "integer",
          "description": "How many maps were asked for; the batch always holds exactly this many."
        },
        "worldSize": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "id",
        "worldSize",
        "requestedCount",
        "readyCount",
        "pendingCount",
        "algorithm",
        "createdAt",
        "candidates"
      ],
      "type": "object",
      "description": "A batch of candidate maps."
    },
    "CandidateResponse": {
      "properties": {
        "facts": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/MapFactsResponse"
            }
          ]
        },
        "image": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/MapPreviewImageResponse",
              "description": "Where the picture is served from RustSC, when ready."
            }
          ]
        },
        "message": {
          "type": [
            "null",
            "string"
          ],
          "description": "A plain sentence for a map that is being made, taking long, could not be made or cannot be made now, or absent."
        },
        "position": {
          "format": "int32",
          "type": "integer",
          "description": "1 based place in the batch."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `no_preview`: `no_map`, `being_made` or `not_configured`. For `pending`: `rate_limited`, `too_many_requests`, `service_unavailable` or `key_rejected`, or absent when not tried yet."
        },
        "seed": {
          "format": "int32",
          "type": "integer"
        },
        "sourceUrl": {
          "type": [
            "null",
            "string"
          ],
          "description": "The map's page at the service, when ready."
        },
        "state": {
          "type": "string",
          "description": "`ready` (the service has the map), `no_preview` (it has none yet, or previews are not set up), `pending` (not looked up yet), `generating` (asked of the service to make, not finished) or `failed` (the service could not make it, or it is taking long)."
        }
      },
      "required": [
        "position",
        "seed",
        "state"
      ],
      "type": "object",
      "description": "One candidate map. Every candidate can be used whatever its state: the game makes the map from the seed and size."
    },
    "ChangeExtensionRequestBody": {
      "properties": {
        "action": {
          "type": "string",
          "description": "`install`, `update` (replace the installed file with the latest release) or `remove`."
        },
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "extension": {
          "type": "string",
          "description": "The extension: `rustedit`."
        },
        "warningMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Minutes of player warning before the server stops, from 0 to the longest warning (60); players\nsee a countdown in chat. Absent means the normal warning of 5 minutes; 0 stops at once."
        }
      },
      "required": [
        "action",
        "extension"
      ],
      "type": "object",
      "description": "An extension change: the action, the extension, the player warning and the optional admission choices."
    },
    "ChangeFrameworkRequestBody": {
      "properties": {
        "action": {
          "type": "string",
          "description": "`remove_old_files` removes, after a switch, the copies of plugins, settings and data left in the old framework's\nfolders that have identical copies in the new framework's folders. The game keeps running. Files that differ or belong to the old framework only stay."
        },
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "backup": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True takes an ordinary backup after the server stops, before anything changes; false takes none. Absent follows the server's\n\"Back up before changes\" setting (on until it is switched off). The backup is listed and rotated with the others. A channel change to an\nolder release always backs up; false is then 422 on `/backup` with reason `required_for_older`."
        },
        "bringBack": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "The answer to \"Bring back your plugins, settings and data?\" on an `install` (422 on `/bringBack` for another action). True carries the\nplugins, settings, data, language files, permission files and RustSC folder the other framework left in its folders into the new framework's\nfolders before it is installed; what the new framework already holds stays, and an older file that differs is saved beside it as\n`&lt;name&gt;.kept-&lt;date&gt;`. Absent or false carries nothing."
        },
        "changeChannel": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True moves the framework to the channel chosen with `selectReleaseChannel` (for example Carbon `edge`) when it differs from the\ninstalled one. Absent or false keeps the installed channel, whatever is chosen. Not for `uninstall` (422 on `/changeChannel`)."
        },
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "`oxide` or `carbon`: the framework to install, upgrade, reinstall or switch to; for `remove_old_files` the old framework whose\ncopies go (not the one installed). Leave it out for `uninstall`."
        },
        "installRustscPlugin": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "The install form's pre-ticked \"Install the RustSC plugin\" option (`install` only; 422 on `/installRustscPlugin` for another action). True also\ninstalls the plugin the host carries after the framework install, so it goes into the new plugin folder once the game is back; false or absent\ninstalls nothing. Needs `plugins.manage`."
        },
        "updateGame": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Not for\n`uninstall` (422 on `/updateGame`). Absent or false changes the framework alone."
        },
        "warningMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Minutes of player warning before the server stops, from 0 to the longest warning (60); players\nsee a countdown in chat. Absent means the normal warning of 5 minutes; 0 stops at once."
        }
      },
      "required": [
        "action"
      ],
      "type": "object",
      "description": "A framework change: the action, the framework, the player warning and the optional admission choices."
    },
    "ChangeGameBranchRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "branch": {
          "type": [
            "null",
            "string"
          ],
          "description": "The Steam branch to move to, for example `staging` or `public`: letters, digits, `.`, `_` and `-`, starting with a letter or digit, at most 64 characters."
        },
        "warningMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Minutes of player warning, as for Update game; absent means the normal 5 minutes, 0 stops at once."
        }
      },
      "type": "object",
      "description": "A change of the game's Steam branch: the branch, the player warning and the optional admission choices."
    },
    "ChangePluginPermissionBody": {
      "properties": {
        "action": {
          "type": [
            "null",
            "string"
          ],
          "description": "`grant`, `revoke`, `group_add`, `group_remove`, `member_add` or `member_remove`."
        },
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "group": {
          "type": [
            "null",
            "string"
          ],
          "description": "The group, for group_add, group_remove, member_add and member_remove."
        },
        "permission": {
          "type": [
            "null",
            "string"
          ],
          "description": "The permission, for grant and revoke."
        },
        "subject": {
          "type": [
            "null",
            "string"
          ],
          "description": "A Steam ID (user), or a group name, for grant and revoke; the Steam ID for member_add and member_remove."
        },
        "subjectKind": {
          "type": [
            "null",
            "string"
          ],
          "description": "`user` or `group`, for grant and revoke."
        }
      },
      "type": "object",
      "description": "One permission or group change."
    },
    "ChangePluginRequestBody": {
      "properties": {
        "action": {
          "type": [
            "null",
            "string"
          ],
          "description": "`enable`, `disable`, `reload`, `remove` or `update`. On a rented server also `check` (see whether the game loaded the plugin) and `put_back` (put the earlier version back after an update the game did not load)."
        },
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "replaceEdited": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Ignored since 8 November 2026: an update always replaces the file (the Keep mine / Replace / Skip question is gone). The member is still accepted so a page open from before keeps working; it is removed with the next breaking revision."
        }
      },
      "type": "object",
      "description": "One action on a plugin file."
    },
    "ChangeServerFilesBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "area": {
          "type": [
            "null",
            "string"
          ],
          "description": "Leave out for the Oxide or Carbon folder. `rustsc` changes RustSC's folder of the server instead (paths start with `rustsc`; only delete, new_file and new_folder)."
        },
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "`oxide` or `carbon`."
        },
        "ifExists": {
          "type": [
            "null",
            "string"
          ],
          "description": "What happens when a copy, move or rename lands on a name that is taken: `keep_both` (default; a free name such as `Kits-2.cs`) or `replace` (the earlier file is kept beside it)."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/ChangeServerFilesItemBody"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "One to 100 changes, done in order."
        }
      },
      "type": "object",
      "description": "Changes to files and folders of the server."
    },
    "ChangeServerFilesItemBody": {
      "properties": {
        "action": {
          "type": [
            "null",
            "string"
          ],
          "description": "`delete`, `discard`, `rename`, `move`, `copy`, `new_file` or `new_folder`."
        },
        "path": {
          "type": [
            "null",
            "string"
          ],
          "description": "The file or folder, below the Oxide or Carbon folder (for example `oxide/plugins/Kits.cs`)."
        },
        "to": {
          "type": [
            "null",
            "string"
          ],
          "description": "The whole new path for rename (same folder), move and copy; absent for the other actions."
        }
      },
      "type": "object",
      "description": "One change of the file manager."
    },
    "ChangeWipeExtraBody": {
      "properties": {
        "files": {
          "items": {
            "$ref": "#/$defs/WipeFileBody"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "New files start a new upload. Absent keeps the files."
        },
        "label": {
          "type": [
            "null",
            "string"
          ]
        },
        "repeat": {
          "type": [
            "null",
            "string"
          ]
        },
        "target": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/WipeTargetBody"
            }
          ]
        },
        "uploadId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The upload (`upl_...`) the new files came from, as for an added extra; only with `files`."
        }
      },
      "type": "object",
      "description": "A change to an extra. Every member is saved as given; the kind and owner cannot change."
    },
    "ChatNameResponse": {
      "properties": {
        "canChange": {
          "type": "boolean",
          "description": "True when the caller may change this name: an Owner, an Administrator or any role that manages members. Everyone else sees the name read only."
        },
        "chatName": {
          "type": "string",
          "description": "The name chat messages go out under now: the chosen name, an empty text when the member chose to send with no name, otherwise the Discord display name, otherwise \"Staff\"."
        },
        "custom": {
          "type": "boolean",
          "description": "True when the member chose (a name, or no name); false when they have not chosen and it is the default."
        },
        "defaultName": {
          "type": "string",
          "description": "The name used when none is chosen (`chatName` is this while `custom` is false)."
        }
      },
      "required": [
        "chatName",
        "custom",
        "defaultName",
        "canChange"
      ],
      "type": "object",
      "description": "The signed-in member's chat name in one workspace: what their chat messages from the portal go out under in the game."
    },
    "ChatRelayBody": {
      "properties": {
        "channelId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The channel's Discord ID, from the list of `listDiscordPostChannels`. Required the first time; absent later keeps the saved channel. Checked again against the workspace's own connected Discord server."
        },
        "discordToGame": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Say the channel's messages in the game. Default true."
        },
        "enabled": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "The kill switch: false stops both directions and keeps the rest. Default true."
        },
        "format": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ChatRelayFormatBody",
              "description": "How the lines look in both directions; absent keeps the defaults of ChatRelayFormatBody (a save replaces the whole format)."
            }
          ]
        },
        "gameToDiscord": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Post the server's global chat in the channel. Default true."
        },
        "mutedSteamIds": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Steam IDs (17 digits) whose chat is not relayed in either direction; at most 100. Absent or empty mutes nobody."
        },
        "whoSpeaks": {
          "type": [
            "null",
            "string"
          ],
          "description": "`anyone` (everyone in the channel except bots) or `linked` (only Discord members linked to a Steam account). Default `anyone`."
        }
      },
      "type": "object",
      "description": "A server's chat relay to store (`PUT` replaces the choices; an absent switch takes the value the form is pre-filled with). The relay is posted in a channel of the\nworkspace's connected Discord server by the RustSC bot."
    },
    "ChatRelayFormatBody": {
      "properties": {
        "emoji": {
          "type": [
            "null",
            "string"
          ],
          "description": "What happens to emoji in a Discord message on its way into the game: `convert` (common ones become emoticons, the rest are removed, default) or `remove`. The game's font draws none."
        },
        "game": {
          "type": [
            "null",
            "string"
          ],
          "description": "How a game line looks in Discord: `plain` (`Name: message`, default), `shown` (`prefix Name: message`, the chat plugin's title and level kept) or `custom` (the template)."
        },
        "nameColor": {
          "type": [
            "null",
            "string"
          ],
          "description": "The colour of the name in the game as `#rrggbb`; absent is the chat's own."
        },
        "nameSource": {
          "type": [
            "null",
            "string"
          ],
          "description": "Which name of the Discord member the game shows: `nickname` (the server nickname, else the display name, default), `display` or `username`."
        },
        "prefix": {
          "type": [
            "null",
            "string"
          ],
          "description": "The text before a Discord member's name in the game, at most 20 characters and no angle brackets; absent is `[Discord]`."
        },
        "prefixColor": {
          "type": [
            "null",
            "string"
          ],
          "description": "The colour of the prefix in the game as `#rrggbb`; absent is the chat's own."
        },
        "template": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `custom`: a template with `{name}`, `{message}` (required), `{prefix}` and `{steamid}`, at most 200 characters. Not stored with another format."
        }
      },
      "type": "object",
      "description": "How the relay's lines look. Every member is optional on a save: an absent one takes its default. Nothing is stored until the member saves."
    },
    "ChatRelayFormatResponse": {
      "properties": {
        "emoji": {
          "type": "string"
        },
        "game": {
          "type": "string"
        },
        "nameColor": {
          "type": [
            "null",
            "string"
          ]
        },
        "nameSource": {
          "type": "string"
        },
        "prefix": {
          "type": "string",
          "description": "The text before a Discord member's name in the game; `[Discord]` unless the member chose another."
        },
        "prefixColor": {
          "type": [
            "null",
            "string"
          ]
        },
        "template": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "game",
        "template",
        "prefix",
        "nameSource",
        "prefixColor",
        "nameColor",
        "emoji"
      ],
      "type": "object",
      "description": "The relay's formats as saved, or the defaults while nothing was saved."
    },
    "ChatRelayResponse": {
      "properties": {
        "channelId": {
          "type": [
            "null",
            "string"
          ]
        },
        "channelName": {
          "type": [
            "null",
            "string"
          ]
        },
        "discordToGame": {
          "type": "boolean"
        },
        "enabled": {
          "type": "boolean"
        },
        "format": {
          "$ref": "#/$defs/ChatRelayFormatResponse"
        },
        "gameToDiscord": {
          "type": "boolean"
        },
        "lastPostedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When Discord last took a post."
        },
        "mutedSteamIds": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "postsFrom": {
          "type": [
            "null",
            "string"
          ],
          "description": "Who posts the server's game chat now: `host` (the server's own host) or `rustsc`; null while no relay is saved."
        },
        "problem": {
          "type": [
            "null",
            "string"
          ],
          "description": "The last problem as a stable code (`no_bot`, `cannot_post`, `channel_gone`, `unreachable`, `rate_limited`, `intent_off`, `other`), or null."
        },
        "problemAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "saved": {
          "type": "boolean",
          "description": "False while no member saved a relay for the server: the values are then what a form is pre-filled with and nothing is relayed."
        },
        "updatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "whoSpeaks": {
          "type": "string"
        }
      },
      "required": [
        "saved",
        "channelId",
        "channelName",
        "enabled",
        "gameToDiscord",
        "discordToGame",
        "whoSpeaks",
        "mutedSteamIds",
        "format",
        "problem",
        "problemAt",
        "lastPostedAt",
        "revision",
        "updatedAt"
      ],
      "type": "object",
      "description": "A server's chat relay and how it is working."
    },
    "ChatWordBody": {
      "properties": {
        "allServers": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True (the default) covers every server; false needs `servers`."
        },
        "enabled": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Default true."
        },
        "mode": {
          "type": "string",
          "description": "`word` or `contains`."
        },
        "phrase": {
          "type": "string"
        },
        "servers": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The servers (`srv_`) the word covers when `allServers` is false."
        }
      },
      "required": [
        "phrase",
        "mode"
      ],
      "type": "object",
      "description": "A chat word to add or the whole of one to replace."
    },
    "ChatWordListResponse": {
      "properties": {
        "canManage": {
          "type": "boolean",
          "description": "Whether the caller may add, change and remove words (`alerts.manage`)."
        },
        "maxLength": {
          "format": "int32",
          "type": "integer"
        },
        "maxWords": {
          "format": "int32",
          "type": "integer"
        },
        "minLength": {
          "format": "int32",
          "type": "integer"
        },
        "words": {
          "items": {
            "$ref": "#/$defs/ChatWordResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "words",
        "canManage",
        "maxWords",
        "minLength",
        "maxLength"
      ],
      "type": "object",
      "description": "The workspace's chat words and the bounds of a word."
    },
    "ChatWordResponse": {
      "properties": {
        "allServers": {
          "type": "boolean",
          "description": "True when the word covers every server."
        },
        "enabled": {
          "type": "boolean"
        },
        "id": {
          "type": "string",
          "description": "The word's ID (`cwd_`)."
        },
        "mode": {
          "type": "string",
          "description": "`word` (a whole word) or `contains` (anywhere inside). Capitals are ignored in both."
        },
        "phrase": {
          "type": "string",
          "description": "The word or phrase as written."
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "servers": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "When `allServers` is false, the servers (`srv_`) it covers."
        }
      },
      "required": [
        "id",
        "phrase",
        "mode",
        "enabled",
        "allServers",
        "servers",
        "revision"
      ],
      "type": "object",
      "description": "A word or phrase that alerts when it is said in a server's public chat."
    },
    "CheckBanFactsBody": {
      "properties": {
        "steamIds": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "1 to 50 Steam IDs."
        }
      },
      "required": [
        "steamIds"
      ],
      "type": "object",
      "description": "Players to check again (`POST .../ban-facts/check`)."
    },
    "CheckHostUpdateRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the host is busy or offline; leave it out to refuse."
            }
          ]
        }
      },
      "type": "object",
      "description": "Asks the host what an update would do."
    },
    "CheckImageRequestBody": {
      "properties": {
        "key": {
          "type": "string",
          "description": "`server.headerimage` or `server.logoimage`."
        },
        "url": {
          "type": "string",
          "description": "An absolute `http` or `https` address."
        }
      },
      "required": [
        "key",
        "url"
      ],
      "type": "object",
      "description": "An image link to look at, for one of the two image settings."
    },
    "CheckImageResponse": {
      "properties": {
        "bytes": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The file size in bytes, when it was read."
        },
        "checkedAt": {
          "format": "date-time",
          "type": "string"
        },
        "height": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Pixels down, when the type was read."
        },
        "httpStatus": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The HTTP status of the final response, when one arrived."
        },
        "limitBytes": {
          "format": "int64",
          "type": "integer",
          "description": "The largest file the check reads, in bytes."
        },
        "notes": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "What differs from the recommendation when the result is `ok`: `size_differs` or `type_not_recommended`. Treat unknown values as other."
        },
        "recommendedSize": {
          "$ref": "#/$defs/ImageSizeResponse",
          "description": "The pixel size recommended for this setting."
        },
        "result": {
          "type": "string",
          "description": "`ok` (a picture was read), `not_an_image`, `bad_status`, `unreachable`,\n`timed_out`, `too_large` or `blocked` (not a public web address). Treat unknown values as other."
        },
        "type": {
          "type": [
            "null",
            "string"
          ],
          "description": "The picture type read from the bytes: `png`, `jpeg`, `gif` or `webp`; otherwise null."
        },
        "width": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Pixels across, when the type was read."
        }
      },
      "required": [
        "result",
        "httpStatus",
        "type",
        "bytes",
        "width",
        "height",
        "recommendedSize",
        "limitBytes",
        "notes",
        "checkedAt"
      ],
      "type": "object",
      "description": "What RustSC found at an image link. The look is a request from RustSC's address through the\negress guard; the picture is measured and dropped, never stored. It informs: the game accepts\nany address, so no result stops a save."
    },
    "CheckMapLinkRequestBody": {
      "properties": {
        "url": {
          "type": [
            "null",
            "string"
          ],
          "description": "The address of the map file, `http` or `https`."
        }
      },
      "type": "object",
      "description": "A custom map address to look at."
    },
    "CheckMapLinkResponse": {
      "properties": {
        "bytes": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The map file's size in bytes, when the address said."
        },
        "checkedAt": {
          "format": "date-time",
          "type": "string"
        },
        "httpStatus": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The address's final HTTP status, when it answered."
        },
        "limitBytes": {
          "format": "int64",
          "type": "integer",
          "description": "The largest map accepted, in bytes."
        },
        "notes": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "For `ok`: `extension_differs` (the address does not end in .map) and `size_unknown`. These inform and never stop a choice."
        },
        "result": {
          "type": "string",
          "description": "`ok` (a file is there), `not_a_file` (a web page), `bad_status`, `unreachable`, `timed_out`,\n`too_large` or `blocked` (not a public web address)."
        }
      },
      "required": [
        "result",
        "limitBytes",
        "notes",
        "checkedAt"
      ],
      "type": "object",
      "description": "What is at a custom map address."
    },
    "CheckPluginAddressBody": {
      "properties": {
        "address": {
          "type": [
            "null",
            "string"
          ],
          "description": "The https address of the plugin file."
        },
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "`oxide` or `carbon`; needed only when both are installed."
        }
      },
      "type": "object",
      "description": "The Check of a plugin file at an address before installing it (`POST .../plugins/actions/check-address`)."
    },
    "CheckPluginInboxBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "framework": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object"
    },
    "CheckPluginSourcesBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "framework": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object"
    },
    "CheckWipePluginAddressBody": {
      "properties": {
        "address": {
          "type": [
            "null",
            "string"
          ],
          "description": "The https address of the plugin file, at most 2000 characters, with no name and password in it."
        },
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "`oxide` or `carbon`: the framework the plugin is installed under."
        }
      },
      "type": "object",
      "description": "The Check of a plugin at a web address."
    },
    "ChooseLinkChannelBody": {
      "properties": {
        "channelId": {
          "type": "string"
        }
      },
      "required": [
        "channelId"
      ],
      "type": "object"
    },
    "ChoosePermissionSyncNewPlayersBody": {
      "properties": {
        "newPlayers": {
          "type": "string"
        }
      },
      "required": [
        "newPlayers"
      ],
      "type": "object",
      "description": "What the sync does for a player this server has not seen yet (`choosePermissionSyncNewPlayers`): `wait` or `add_before`."
    },
    "ChoosePluginMarketplaceBody": {
      "properties": {
        "marketplace": {
          "type": [
            "null",
            "string"
          ],
          "description": "A marketplace code from the server's `marketplaces` that lists the plugin (`found`)."
        }
      },
      "type": "object",
      "description": "The marketplace to follow for one plugin."
    },
    "CleanUpFilesBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "rules": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The rules to run: `old_logs` and `leftover_world`. Absent runs both."
        }
      },
      "type": "object",
      "description": "Free up space: the rules to run (left out: the defaults, old logs and leftover world files) and the optional admission choices."
    },
    "ClientErrorBody": {
      "properties": {
        "appVersion": {
          "type": [
            "null",
            "string"
          ],
          "description": "The portal's version."
        },
        "errorName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The error's type name such as `TypeError`."
        },
        "route": {
          "type": [
            "null",
            "string"
          ],
          "description": "The route pattern such as `/w/:workspaceId/servers/:serverId`, never a real identifier or a query."
        },
        "status": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The failed answer's status, or 0 when the screen failed without one."
        },
        "traceId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The failed answer's reference, when it gave one."
        }
      },
      "type": "object",
      "description": "What the portal sends when a screen fails. Five short values and nothing else (an unknown field is refused)."
    },
    "ClosingContentResponse": {
      "properties": {
        "count": {
          "format": "int32",
          "type": "integer"
        },
        "name": {
          "type": "string",
          "description": "The kind, as the data download names its sections: `members`, `hosts`, `servers`, `schedules` and so on."
        }
      },
      "required": [
        "name",
        "count"
      ],
      "type": "object",
      "description": "One kind of thing a closing deletes."
    },
    "ClosingResponse": {
      "properties": {
        "closingAt": {
          "format": "date-time",
          "type": "string"
        },
        "deleteAfter": {
          "format": "date-time",
          "type": "string",
          "description": "When the workspace's data is deleted for good."
        },
        "reason": {
          "type": "string",
          "description": "`owner` (an owner closed it) or `account_deletion` (its only member deleted their account)."
        }
      },
      "required": [
        "closingAt",
        "deleteAfter",
        "reason"
      ],
      "type": "object",
      "description": "A closing workspace. Its data can be downloaded and closing cancelled until `deleteAfter`."
    },
    "CodeflingCheckResponse": {
      "properties": {
        "accountName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The Codefling account's name when Codefling returned it for this key; an Account API key may not read it."
        },
        "codeflingStatus": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The HTTP status of the Codefling answer that decided a problem result; null when the key works or Codefling did not answer."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "One lower-case word for a problem result: Codefling's own error constant (for example `invalid_access_token`) or `no_answer`,\n`rate_limited`, `not_json`, `no_reason`, `odd_answer`. Null when the key works. Never the key, a header or a body."
        },
        "result": {
          "type": "string",
          "description": "`works` (Codefling accepted the key), `wrong_key` (not accepted: wrong, removed on Codefling or expired), `not_allowed` (accepted but\nit may not download files) or `unreachable` (Codefling did not answer)."
        }
      },
      "required": [
        "result"
      ],
      "type": "object",
      "description": "What Codefling said about the key."
    },
    "CodeflingConnectionResponse": {
      "properties": {
        "available": {
          "type": "boolean",
          "description": "False while RustSC has the Codefling connection switched off; nothing can be saved and the portal shows nothing."
        },
        "check": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/CodeflingCheckResponse",
              "description": "What Codefling said about the key, when this request asked it (a save or Check key); null otherwise."
            }
          ]
        },
        "isSet": {
          "type": "boolean",
          "description": "True while a key is saved."
        },
        "run": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/CodeflingRunResponse",
              "description": "Where the workspace's Codefling calls run, and for a check made by this request where that check ran (host-first integrations): the portal says \"Works from your host\"\nor \"Works from RustSC\". Null while no key is saved. The key is delivered to a host only when a member's Install from Codefling reaches a server of that host."
            }
          ]
        },
        "updatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the key was last saved; null while none is."
        }
      },
      "required": [
        "available",
        "isSet"
      ],
      "type": "object",
      "description": "The workspace's Codefling connection. Never the key."
    },
    "CodeflingKeyBody": {
      "properties": {
        "key": {
          "type": [
            "null",
            "string"
          ],
          "description": "The access token of an Account API app from Codefling's Apps page (codefling.com/settings/apps)."
        }
      },
      "type": "object",
      "description": "The workspace's own Codefling key to store. Write-only: it is stored as a protected secret and never returned."
    },
    "CodeflingRunResponse": {
      "properties": {
        "door": {
          "type": "string",
          "description": "`host` (a host of the workspace held the key and made the calls) or `cloud` (RustSC made them with its own copy of the key)."
        },
        "hostName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name of the host that made the calls; null for the cloud."
        },
        "reason": {
          "type": "string",
          "description": "Why: `preferred_host`, `failover_host` or `server_host` for a host; `server_has_no_host`, `no_connected_host`, `host_needs_update`,\n`host_lacks_key` or `host_did_not_answer` for the cloud."
        }
      },
      "required": [
        "door",
        "reason"
      ],
      "type": "object",
      "description": "Where Codefling was asked from: a host of the workspace or the RustSC cloud, and why."
    },
    "CommandParameterBody": {
      "properties": {
        "maximum": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ]
        },
        "minimum": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "type": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object",
      "description": "A declared parameter: `type` is `text`, `integer`, `boolean` or `steam_id`; `minimum` and `maximum` only for `integer`."
    },
    "CommandRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "command": {
          "type": [
            "null",
            "string"
          ]
        },
        "keepOutput": {
          "type": [
            "null",
            "boolean"
          ]
        }
      },
      "type": "object",
      "description": "One console command typed by the caller (the portal's console)."
    },
    "CommandResultResponse": {
      "properties": {
        "deliveryState": {
          "type": "string",
          "description": "confirmed only when the actual send stage recorded a completed RCON result; otherwise unconfirmed."
        },
        "operationId": {
          "type": "string",
          "description": "The operation being read."
        },
        "outputText": {
          "type": [
            "null",
            "string"
          ],
          "description": "The exact retained redacted text, or null when unavailable. Never rendered as markup."
        },
        "outputTruncated": {
          "type": "boolean",
          "description": "True when retained output omitted or cut frames, or some frames could not be attributed."
        },
        "outputUnavailableReason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Null when text is returned; otherwise pending, not_requested, store_unavailable, store_failed, no_reply, reply_too_large, record_unavailable, host_offline, unsupported_host, timed_out or permission_denied."
        }
      },
      "required": [
        "operationId",
        "deliveryState",
        "outputText",
        "outputTruncated",
        "outputUnavailableReason"
      ],
      "type": "object",
      "description": "A correlated read of one command or broadcast. No command is sent or repeated."
    },
    "CommunityBanListResponse": {
      "properties": {
        "addressHint": {
          "type": "string",
          "description": "Where the list is, with the path left out (`https://bans.example.com/...`): the address may hold a key, so it is never shown again after it is saved."
        },
        "appealsUrl": {
          "type": [
            "null",
            "string"
          ]
        },
        "enforce": {
          "type": "boolean",
          "description": "True removes a listed player a few seconds after they join; false only shows the answer on the player."
        },
        "id": {
          "type": "string",
          "description": "The list's ID: 32 lower case hexadecimal characters."
        },
        "keyPlacement": {
          "type": [
            "null",
            "string"
          ],
          "description": "Where the key goes: `api_key_header`, `bearer` or `query_key`; null when no key is set."
        },
        "keySet": {
          "type": "boolean",
          "description": "True when the member added a key for this list apart from its address. The key itself is never returned."
        },
        "message": {
          "type": "string",
          "description": "What a removed player sees."
        },
        "name": {
          "type": "string"
        },
        "runBy": {
          "type": "string",
          "description": "Who runs the list; shown beside every fact from it."
        },
        "source": {
          "type": "string",
          "description": "How the list is kept: `centralized` is a list in Rust's centralized banning format. Other values may be added."
        }
      },
      "required": [
        "id",
        "name",
        "runBy",
        "addressHint",
        "enforce",
        "message",
        "keySet"
      ],
      "type": "object",
      "description": "A community list with the workspace's choice for it."
    },
    "CompanionCommandResponse": {
      "properties": {
        "feature": {
          "type": "string",
          "description": "The plugin feature, for example `player.link`."
        },
        "name": {
          "type": "string",
          "description": "The command without the slash."
        },
        "observedAt": {
          "format": "date-time",
          "type": "string"
        },
        "plugin": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `clash`: the other plugin's name when the framework said which, else null."
        },
        "serverId": {
          "type": "string"
        },
        "state": {
          "type": "string",
          "description": "`on`, `clash`, `off` or `unknown` (the plugin could not read the framework's command list, so it left the command off)."
        }
      },
      "required": [
        "serverId",
        "feature",
        "name",
        "state",
        "observedAt"
      ],
      "type": "object",
      "description": "One player command of the RustSC plugin on one server."
    },
    "CompanionCommandsResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/CompanionCommandResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object",
      "description": "The RustSC plugin's player commands on every server of the workspace."
    },
    "ComponentVersionResponse": {
      "properties": {
        "channel": {
          "type": "string",
          "description": "The channel an update acts on: the Steam branch for the game (for example `public`), the RustSC channel for a framework (Oxide `public`, Carbon `production`)."
        },
        "channelSource": {
          "type": "string",
          "description": "`selection` when a channel was chosen, `install` when it is the branch the server was installed from (for a framework: its production channel)."
        },
        "comparison": {
          "type": "string",
          "description": "`current` (the latest build checked recently is installed), `update_available`,\n`unavailable` (the channel is gone or needs a password) or `unknown`. Never\n`current` on old data: see `currentUntil`. Treat unknown values as `unknown`."
        },
        "component": {
          "type": "string",
          "description": "`game` (the Rust dedicated server), `oxide`, `carbon` or a supporting extension (`rustedit`). Treat unknown values as other."
        },
        "currentUntil": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When a `current` answer stops counting as current, UTC; check again after it."
        },
        "framework": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/FrameworkVersionResponse",
              "description": "For the game: the framework the server's files point to, or null before one was reported. Null for a framework."
            }
          ]
        },
        "installed": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/InstalledVersionResponse",
              "description": "The installed version, or null before the host reported one."
            }
          ]
        },
        "latest": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/LatestVersionResponse",
              "description": "The newest check of the channel, or null when the channel was never checked."
            }
          ]
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why the comparison is `unknown` or `unavailable`: `not_checked`,\n`check_stale`, `check_failed`, `update_failed`, `install_incomplete`,\n`target_change`, `version_unreadable`, `channel_missing`, `password_required`, and for a\nframework or extension `not_installed` or `change_failed`, and for an extension with no release source yet `source_pending`\nor, for a copy an adoption found whose version could not be read, `version_not_read`."
        },
        "requires": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a supporting extension: the framework it needs to load (`oxide`). Null for the game and the frameworks."
        },
        "updatesEnabled": {
          "type": "boolean",
          "description": "Whether RustSC updates this channel. Only production builds are enabled (Rust `public`, Oxide `public`, Carbon `production`); other channels are shown but never updated."
        }
      },
      "required": [
        "component",
        "channel",
        "channelSource",
        "updatesEnabled",
        "installed",
        "latest",
        "comparison",
        "reason",
        "currentUntil",
        "framework"
      ],
      "type": "object",
      "description": "One component of a server: the installed version, the latest version for its channel and how they\ncompare. They are kept apart: `installed` is what the host verified on the server, `latest` is\nwhat the platform read from Steam for the game's branch, or the provider's release listing named for a framework's\nchannel, at `latest.retrievedAt`."
    },
    "ConfigurationApplicationResponse": {
      "properties": {
        "errorCode": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why it failed, for example `config_file_conflict`; null unless failed."
        },
        "fields": {
          "items": {
            "$ref": "#/$defs/ConfigurationFieldOutcomeResponse"
          },
          "type": "array",
          "description": "What the host reported per setting; empty while pending and after a failure as a whole."
        },
        "operationId": {
          "type": "string",
          "description": "The operation that applies the configuration."
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "startedAt": {
          "format": "date-time",
          "type": "string"
        },
        "state": {
          "type": "string",
          "description": "`pending`, `applied`, `restart_required` or `failed`. Treat unknown values as other."
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "operationId",
        "revision",
        "state",
        "errorCode",
        "startedAt",
        "updatedAt",
        "fields"
      ],
      "type": "object",
      "description": "One apply of a saved revision and what the host reported for each setting."
    },
    "ConfigurationFieldOutcomeResponse": {
      "properties": {
        "key": {
          "type": "string"
        },
        "outcome": {
          "type": "string",
          "description": "`applied`, `restart_required` or `rejected`. Treat unknown values as other."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "A safe reason code for a rejection, never the value; otherwise null."
        }
      },
      "required": [
        "key",
        "outcome",
        "reason"
      ],
      "type": "object",
      "description": "The host's outcome for one setting."
    },
    "ConfigurationObservationCaptureResponse": {
      "properties": {
        "operationId": {
          "type": "string"
        },
        "receivedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the result was last updated."
        },
        "requestedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the read was requested."
        },
        "snapshot": {
          "$ref": "#/$defs/ConfigurationObservationSnapshot",
          "description": "Sanitized bounded source facts. StartedAt and CapturedAt use the host clock and do not order remote requests."
        }
      },
      "required": [
        "operationId",
        "requestedAt",
        "receivedAt",
        "snapshot"
      ],
      "type": "object"
    },
    "ConfigurationObservationInstance": {
      "properties": {
        "bootId": {
          "type": "string"
        },
        "launchId": {
          "type": "string"
        },
        "processId": {
          "format": "int32",
          "type": "integer"
        },
        "startTimeTicks": {
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "launchId",
        "processId",
        "startTimeTicks",
        "bootId"
      ],
      "type": "object",
      "description": "Exact process generation checked around the sample; never control authority from a caller."
    },
    "ConfigurationObservationRequestResponse": {
      "properties": {
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "error": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationErrorResponse"
            }
          ]
        },
        "final": {
          "type": "boolean"
        },
        "finishedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "operationId": {
          "type": "string"
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "state": {
          "type": "string"
        }
      },
      "required": [
        "operationId",
        "state",
        "revision",
        "final",
        "createdAt",
        "finishedAt",
        "error"
      ],
      "type": "object"
    },
    "ConfigurationObservationResponse": {
      "properties": {
        "applyRoute": {
          "type": "string",
          "description": "Where an apply goes: host (the RustSC app on the host), rented (a server at a hosting company, applied through that host's file login or API, its startup settings and the\ngame's console), or none (nothing can apply the settings here, for example a rented server whose connection cannot change files)."
        },
        "canApplyCustom": {
          "type": "boolean",
          "description": "Both configuration write and console execution authority, needed to apply a revision containing uncurated names."
        },
        "canEdit": {
          "type": "boolean",
          "description": "Whether you can edit this server's configuration."
        },
        "canInspect": {
          "type": "boolean",
          "description": "Whether you can request another read."
        },
        "canRestart": {
          "type": "boolean",
          "description": "Whether you have permission to restart the server."
        },
        "connected": {
          "type": "boolean"
        },
        "installationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The current installation this view describes."
        },
        "lastSuccessful": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ConfigurationObservationCaptureResponse",
              "description": "The last successful read. It may be partial or older than the latest request."
            }
          ]
        },
        "latestRequest": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ConfigurationObservationRequestResponse",
              "description": "The latest configuration read request, including pending and failed requests."
            }
          ]
        },
        "support": {
          "type": "string",
          "description": "Whether the server supports a configuration read."
        },
        "supportReason": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "support",
        "supportReason",
        "installationId",
        "connected",
        "canInspect",
        "canEdit",
        "canApplyCustom",
        "canRestart",
        "applyRoute",
        "latestRequest",
        "lastSuccessful"
      ],
      "type": "object"
    },
    "ConfigurationObservationSnapshot": {
      "properties": {
        "approvedRevision": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ]
        },
        "capturedAt": {
          "format": "date-time",
          "type": "string"
        },
        "configurationId": {
          "type": [
            "null",
            "string"
          ]
        },
        "failure": {
          "type": [
            "null",
            "string"
          ]
        },
        "file": {
          "$ref": "#/$defs/ConfigurationObservedFile"
        },
        "instance": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ConfigurationObservationInstance"
            }
          ]
        },
        "launch": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ConfigurationObservedLaunch"
            }
          ]
        },
        "planSha256": {
          "type": [
            "null",
            "string"
          ]
        },
        "runtimeState": {
          "type": "string"
        },
        "startedAt": {
          "format": "date-time",
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "truncated": {
          "type": "boolean"
        },
        "variables": {
          "items": {
            "$ref": "#/$defs/ConfigurationObservedVariable"
          },
          "type": "array"
        }
      },
      "required": [
        "startedAt",
        "capturedAt",
        "state",
        "failure",
        "configurationId",
        "approvedRevision",
        "planSha256",
        "runtimeState",
        "instance",
        "file",
        "variables",
        "truncated"
      ],
      "type": "object",
      "description": "Host-clock capture window and independent source facts, not a live freshness promise."
    },
    "ConfigurationObservedFile": {
      "properties": {
        "changedSinceLastWrite": {
          "type": "boolean"
        },
        "editedManaged": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "error": {
          "type": [
            "null",
            "string"
          ]
        },
        "exists": {
          "type": "boolean"
        },
        "sha256": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "exists",
        "sha256",
        "error",
        "changedSinceLastWrite",
        "editedManaged"
      ],
      "type": "object"
    },
    "ConfigurationObservedLaunch": {
      "properties": {
        "addedCount": {
          "format": "int32",
          "type": "integer"
        },
        "addedFrom": {
          "format": "int32",
          "type": "integer"
        },
        "arguments": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "arguments",
        "addedFrom",
        "addedCount"
      ],
      "type": "object",
      "description": "The command line the next start uses, redacted (the RCON password and any secret value are replaced), with the\npart the saved launch settings added marked so a screen can show a pending change in place. `Arguments[AddedFrom..AddedFrom+AddedCount]` are the chosen flags and extra arguments; the rest is\ncompiled by RustSC or kept from an adopted start script."
    },
    "ConfigurationObservedVariable": {
      "properties": {
        "curated": {
          "type": "boolean"
        },
        "desired": {
          "type": [
            "null",
            "string"
          ]
        },
        "file": {
          "type": [
            "null",
            "string"
          ]
        },
        "fileMatchesDesired": {
          "type": [
            "null",
            "boolean"
          ]
        },
        "filePresent": {
          "type": [
            "null",
            "boolean"
          ]
        },
        "name": {
          "type": "string"
        },
        "nextStartSource": {
          "type": "string"
        },
        "running": {
          "type": [
            "null",
            "string"
          ]
        },
        "runningStatus": {
          "type": "string"
        },
        "secret": {
          "type": "boolean"
        },
        "startupArgument": {
          "type": [
            "null",
            "string"
          ]
        },
        "startupArgumentMatchesDesired": {
          "type": [
            "null",
            "boolean"
          ]
        },
        "startupArgumentPresent": {
          "type": [
            "null",
            "boolean"
          ]
        }
      },
      "required": [
        "name",
        "curated",
        "secret",
        "desired",
        "file",
        "startupArgument",
        "nextStartSource",
        "running",
        "runningStatus",
        "filePresent",
        "startupArgumentPresent",
        "fileMatchesDesired",
        "startupArgumentMatchesDesired"
      ],
      "type": "object",
      "description": "Unknown actual values are withheld; presence and comparisons disclose no unmanaged text."
    },
    "ConfigurationPatchBody": {
      "properties": {
        "values": {
          "additionalProperties": {},
          "type": "object"
        }
      },
      "required": [
        "values"
      ],
      "type": "object",
      "description": "Changes to save, as a JSON merge patch (RFC 7396) of the values: a value sets the setting\n(a string for text and URLs, a whole number, a boolean, or an array of strings for a list),\n`null` unsets it, and settings not named keep their value. Each value is replaced as a\nwhole."
    },
    "ConfigurationSettingResponse": {
      "properties": {
        "allowEmpty": {
          "type": "boolean",
          "description": "Whether empty text or an empty list is accepted."
        },
        "applyMode": {
          "type": "string",
          "description": "When a change takes effect: `live` (set on the running game), `next_start`, or\n`unknown` (not verified on a real game, so a restart may be needed). Treat unknown values as other."
        },
        "choices": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "For a `choice` setting, the values it takes in display order; the first is the default\nand an unset setting means the default. Null for every other kind."
        },
        "displayLimit": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/DisplayLimitResponse",
              "description": "Where the server list cuts this text, or null: the name after 63 bytes of UTF-8 and the\ndescription after 1,600 UTF-16 code units (measured). The game accepts longer text, so this\ninforms and never refuses."
            }
          ]
        },
        "key": {
          "type": "string",
          "description": "The console variable, for example `server.hostname`."
        },
        "kind": {
          "type": "string",
          "description": "`text`, `integer`, `boolean`, `text_list` or `choice` (one of IReadOnlyList&lt;string&gt;? ConfigurationSettingResponse.Choices). Treat unknown values as other."
        },
        "lineBreaks": {
          "type": "boolean",
          "description": "Whether the text may hold `\\n` (a backslash then `n`), Rust's line break in this\nvalue, for example in `server.description`. Real line breaks and other backslashes are\nstill refused, so a form converts each new line to `\\n` on save and back on load."
        },
        "maximum": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The largest whole number accepted, or null."
        },
        "minimum": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The smallest whole number accepted, or null."
        },
        "recommendedImage": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ImageSizeResponse",
              "description": "The pixel size recommended for an image setting, or null. The game accepts any size, so this informs and never refuses."
            }
          ]
        },
        "tags": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/TagVocabularyResponse",
              "description": "The documented server browser tags with their groups, for `server.tags`; null for every other setting."
            }
          ]
        },
        "unit": {
          "type": [
            "null",
            "string"
          ],
          "description": "The unit of a number (`count`, `seconds`), or null."
        },
        "url": {
          "type": "boolean",
          "description": "Whether the text must be empty or an absolute `http` or `https` URL."
        }
      },
      "required": [
        "key",
        "kind",
        "unit",
        "applyMode",
        "allowEmpty",
        "minimum",
        "maximum",
        "url",
        "lineBreaks",
        "choices",
        "displayLimit",
        "tags",
        "recommendedImage"
      ],
      "type": "object",
      "description": "One managed setting and the rules a save checks."
    },
    "ConnectDiscordBody": {
      "properties": {
        "guildId": {
          "type": "string",
          "description": "The Discord server ID Discord returned."
        },
        "state": {
          "type": "string",
          "description": "The state Discord returned."
        }
      },
      "required": [
        "state",
        "guildId"
      ],
      "type": "object"
    },
    "ConnectedPlayerResponse": {
      "properties": {
        "connectedSeconds": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "Whole seconds since this session connected."
        },
        "health": {
          "format": "double",
          "type": [
            "null",
            "number"
          ],
          "description": "Health points as the game reports them."
        },
        "ip": {
          "type": [
            "null",
            "string"
          ],
          "description": "The IP address without the port. Needs `players.read.sensitive` (Owner and\nAdministrator); null with `masked` true otherwise, and null with `masked` false\nwhen the address is not known."
        },
        "masked": {
          "type": "boolean"
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the game shows; a label, never an identity."
        },
        "pingMs": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "Round trip time in milliseconds."
        },
        "state": {
          "type": "string",
          "description": "Always `connected`: `playerlist` lists only connected players."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID as a decimal string; keep it a string."
        }
      },
      "required": [
        "steamId",
        "state",
        "masked"
      ],
      "type": "object",
      "description": "One connected player."
    },
    "ConsoleFilterResponse": {
      "properties": {
        "durations": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "on": {
          "type": "boolean"
        },
        "onTheHost": {
          "type": "boolean",
          "description": "False for a server with no agent: the portal then applies the rule to the lines it receives."
        },
        "until": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the filter ends by itself; absent when it is off."
        }
      },
      "required": [
        "on",
        "durations",
        "onTheHost"
      ],
      "type": "object"
    },
    "ConsoleSearchLineResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": "string",
          "description": "When the host read the line, or when a summary's window closed."
        },
        "kind": {
          "type": "string",
          "description": "`line`, or `summary` for a window of collapsed repeats."
        },
        "repeatCount": {
          "format": "int64",
          "type": "integer",
          "description": "1 for a line; the counted copies for a summary."
        },
        "source": {
          "type": "string",
          "description": "`rcon` (the game's own output), `reply` (the reply to a command run through RustSC) or `runner`."
        },
        "stacktrace": {
          "type": [
            "null",
            "string"
          ]
        },
        "text": {
          "type": "string"
        },
        "truncated": {
          "type": "boolean",
          "description": "The text or stack trace was cut, by the game's limit or to fit one message."
        },
        "type": {
          "type": "string",
          "description": "The game's entry type, for example `Generic`, `Warning`, `Error` or `Chat`."
        }
      },
      "required": [
        "kind",
        "at",
        "source",
        "type",
        "text",
        "truncated",
        "repeatCount"
      ],
      "type": "object",
      "description": "One line of an answer, in the shape of a live console item."
    },
    "ConsoleSearchRequestBody": {
      "properties": {
        "classes": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The chips: `chat`, `warnings`, `errors`, `commands`. Missing or empty means every line."
        },
        "matchCase": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "<b>Match case</b>. Off when missing."
        },
        "pattern": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "<b>Pattern</b>: `text` is a regular expression the host runs in linear time. Off when missing."
        },
        "period": {
          "type": [
            "null",
            "string"
          ],
          "description": "`hour`, `day` or `all` the host kept, measured on the host's clock. A rented server also takes `yesterday` (the whole previous day, UTC) and `week` (the last seven days), read from the game's own files. Required."
        },
        "text": {
          "type": [
            "null",
            "string"
          ],
          "description": "The search text; empty or missing for none. At most 200 characters."
        }
      },
      "type": "object",
      "description": "A search of older console lines: the same options as\nevery console search, and how far back to look. The text and the options travel in the body, never in the address, so a\nsearch is not written to access logs."
    },
    "ConsoleSearchResponse": {
      "properties": {
        "damagedSegments": {
          "format": "int64",
          "type": "integer",
          "description": "Segments of the log whose end could not be read (a crash cut them); the lines before the damage were searched."
        },
        "lines": {
          "items": {
            "$ref": "#/$defs/ConsoleSearchLineResponse"
          },
          "type": "array",
          "description": "The matching lines, newest first, redacted like the live console. At most 1,000."
        },
        "oldestSearched": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The time of the oldest line of the oldest segment the host read in full; null when it read none."
        },
        "scannedLines": {
          "format": "int64",
          "type": "integer",
          "description": "Lines the host read, matching or not."
        },
        "stopped": {
          "type": "string",
          "description": "`finished`, `scan_limit` (the host read the most lines a search may), `time_limit` (it ran out of time),\n`result_limit` (more lines match than are returned: these are the newest) or `budget` (the workspace's daily console\nallowance ran out, so the lines after that point were not sent)."
        }
      },
      "required": [
        "stopped",
        "lines",
        "scannedLines",
        "damagedSegments"
      ],
      "type": "object",
      "description": "What a host's search of its kept console log found. `stopped` says why it ended: `finished` means it read everything the\nperiod asked for, and only then is an empty `lines` \"no matches\"; every other value means older lines may exist that were not\nread or not returned."
    },
    "ConsoleStormListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/ConsoleStormResponse"
          },
          "type": "array",
          "description": "Newest first; at most the requested limit (default 10, most 20). Storms older than 14 days are not shown."
        }
      },
      "required": [
        "items"
      ],
      "type": "object"
    },
    "ConsoleStormResponse": {
      "properties": {
        "endedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "Absent while the storm lasts."
        },
        "id": {
          "type": "string"
        },
        "line": {
          "type": [
            "null",
            "string"
          ],
          "description": "The repeated line with the changing values masked, already cleaned by the host and at most 160 characters; absent when none was counted."
        },
        "linesCollapsed": {
          "format": "int64",
          "type": "integer",
          "description": "Repeated copies the host counted instead of keeping, while the storm lasted; 0 until it ends."
        },
        "linesNotKept": {
          "format": "int64",
          "type": "integer",
          "description": "Lines the host lost, skipped or did not process while the storm lasted; 0 until it ends."
        },
        "startedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "id",
        "startedAt",
        "linesCollapsed",
        "linesNotKept"
      ],
      "type": "object",
      "description": "One console storm of a server: the same line repeating, as the host counted it."
    },
    "ConsoleWordBody": {
      "properties": {
        "allServers": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True (the default) covers every server; false needs `servers`."
        },
        "enabled": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Default true."
        },
        "mode": {
          "type": "string",
          "description": "`word`, `contains` or `pattern`."
        },
        "phrase": {
          "type": "string"
        },
        "servers": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The servers (`srv_`) the word covers when `allServers` is false."
        }
      },
      "required": [
        "phrase",
        "mode"
      ],
      "type": "object",
      "description": "A console word to add or the whole of one to replace."
    },
    "ConsoleWordListResponse": {
      "properties": {
        "canManage": {
          "type": "boolean",
          "description": "Whether the caller may add, change and remove words (`alerts.manage`)."
        },
        "maxLength": {
          "format": "int32",
          "type": "integer",
          "description": "The longest word or phrase."
        },
        "maxPatternLength": {
          "format": "int32",
          "type": "integer",
          "description": "The longest pattern."
        },
        "maxWords": {
          "format": "int32",
          "type": "integer"
        },
        "minLength": {
          "format": "int32",
          "type": "integer"
        },
        "words": {
          "items": {
            "$ref": "#/$defs/ConsoleWordResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "words",
        "canManage",
        "maxWords",
        "minLength",
        "maxLength",
        "maxPatternLength"
      ],
      "type": "object",
      "description": "The workspace's console words and the bounds of a word."
    },
    "ConsoleWordResponse": {
      "properties": {
        "allServers": {
          "type": "boolean",
          "description": "True when the word covers every server."
        },
        "enabled": {
          "type": "boolean"
        },
        "id": {
          "type": "string",
          "description": "The word's ID (`cow_`)."
        },
        "mode": {
          "type": "string",
          "description": "`word` (a whole word), `contains` (anywhere inside) or `pattern` (a regular expression). Capitals are ignored in all three."
        },
        "phrase": {
          "type": "string",
          "description": "The word, phrase or pattern as written."
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "servers": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "When `allServers` is false, the servers (`srv_`) it covers."
        }
      },
      "required": [
        "id",
        "phrase",
        "mode",
        "enabled",
        "allServers",
        "servers",
        "revision"
      ],
      "type": "object",
      "description": "A word, phrase or pattern that alerts when a server's console prints it."
    },
    "ContainerItemResponse": {
      "properties": {
        "amount": {
          "format": "int32",
          "type": "integer"
        },
        "displayName": {
          "type": "string"
        },
        "shortName": {
          "type": "string"
        },
        "slot": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "slot",
        "shortName",
        "displayName",
        "amount"
      ],
      "type": "object"
    },
    "ContainerItemsResponse": {
      "properties": {
        "displayName": {
          "type": [
            "null",
            "string"
          ]
        },
        "found": {
          "type": "boolean"
        },
        "generation": {
          "type": "string"
        },
        "items": {
          "items": {
            "$ref": "#/$defs/ContainerItemResponse"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why not: `entity_not_found`, `generation_changed` or `not_a_container`."
        },
        "revision": {
          "type": [
            "null",
            "string"
          ],
          "description": "What a removal must send back; it names exactly this content."
        },
        "total": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many stacks it holds (the list shows at most 100)."
        },
        "x": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "z": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        }
      },
      "required": [
        "found",
        "generation"
      ],
      "type": "object"
    },
    "CopyServerRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the host is busy or offline; leave it out to refuse."
            }
          ]
        },
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "The framework the backup holds (from the check's backup member): `oxide` or `carbon`. The new server receives the same framework,\nat its production release, before the backup is restored, and is not started. Leave it out, or `none`, for a backup of a server with none."
        },
        "identity": {
          "type": [
            "null",
            "string"
          ],
          "description": "The save identity the backup holds (from the check), for example `rustsc`; leave it out for RustSC's own."
        },
        "map": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ServerMapBody",
              "description": "The map the backup holds, from the check's backup member (level, worldSize and seed). Required: the new server must launch the\nbackup's map, or the game would load its own and leave the copy unused. A custom map (levelUrl) cannot be copied."
            }
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The new server's display name, a label for lists and operation summaries."
        },
        "ports": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ServerPortsBody",
              "description": "The new server's ports, as for adding a server; leave it out for the conventional ports."
            }
          ]
        },
        "root": {
          "type": [
            "null",
            "string"
          ],
          "description": "The existing folder on the host to install the new server into, as for adding a server."
        }
      },
      "type": "object",
      "description": "Copies a backup of a server as a new server on the same host."
    },
    "CopyTimedChangeFolderBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The copy's name; left out, the name of the original and \" copy\"."
        },
        "targetServerId": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object",
      "description": "Copy a schedule that reads its folder to another server; the copy arrives paused."
    },
    "CountEntitiesRequestBody": {
      "properties": {
        "ownerSteamId": {
          "type": [
            "null",
            "string"
          ],
          "description": "Count only what the game says this player owns. A host from before ignores it and answers the whole world without `ownerSteamId` in the answer."
        },
        "quiet": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True for a lookup a screen makes by itself: it is not listed in Activity and not announced when it ends, whatever its end. Leave out for one a person asked for."
        },
        "top": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many of the most common prefabs to list, 1 to 100. Left out, 30."
        }
      },
      "type": "object",
      "description": "Counts what the world holds."
    },
    "CountOwnedEntitiesRequestBody": {
      "properties": {
        "max": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The most players to list, most entities first: 1 to 1000, 1000 when left out."
        },
        "maxAgeSeconds": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "A kept count this many seconds old or newer is returned instead of a new pass: 0 to 300, 30 when left out. 0 forces a new pass (Refresh)."
        },
        "quiet": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True for a lookup a screen makes by itself: it is not listed in Activity and not announced when it ends, whatever its end. Leave out for one a person asked for."
        }
      },
      "type": "object",
      "description": "Counts what every player owns."
    },
    "CountryRuleBody": {
      "properties": {
        "blocked": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Two capital letter country codes, at most 250."
        },
        "enabled": {
          "type": "boolean"
        },
        "message": {
          "type": "string"
        }
      },
      "required": [
        "enabled",
        "blocked",
        "message"
      ],
      "type": "object",
      "description": "Players from the listed countries are removed. A country that cannot be told never matches."
    },
    "CreateApiKeyBody": {
      "properties": {
        "access": {
          "type": "string",
          "description": "`read` or `read_write`."
        },
        "agent": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True to make a key for an AI assistant or an unattended agent (the remote MCP endpoint accepts it). It must expire, in 30 or 90 days. Optional: when left out the key is a plain API key."
        },
        "allServers": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "For an `agent` key only: true to let it reach every server, those added later too. Left out or false, the key reaches only the servers in `serverIds`, and an\nempty `serverIds` is no server at all, so a new assistant key sees nothing until its person chooses. Giving both `allServers` true and servers is refused. A plain key ignores it: an empty `serverIds` is the whole workspace."
        },
        "expiresInDays": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Days until the key stops working: 30, 90 or 365; null for a key that does not expire. Always sent, so leaving it out never means \"never\"."
        },
        "name": {
          "type": "string",
          "description": "A name to recognise the key by, 1 to 60 characters."
        },
        "role": {
          "type": [
            "null",
            "string"
          ],
          "description": "The role of an agent key: `viewer`, `moderator`, `operator`, `administrator` or `owner`. Only for `agent` keys. Left out, the key is a Viewer\n(and `access` must be `read`); a role above Viewer needs `access` `read_write`. Never above your own role."
        },
        "serverIds": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The servers the key covers; null or empty for the whole workspace. Always sent, so leaving it out never means \"everything\"."
        }
      },
      "required": [
        "name",
        "access",
        "serverIds",
        "expiresInDays"
      ],
      "type": "object",
      "description": "Make an integration key or an agent key."
    },
    "CreateBackupRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        }
      },
      "type": "object",
      "description": "A manual backup: only the optional admission choices."
    },
    "CreateCandidatesRequestBody": {
      "properties": {
        "count": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many different maps to find, 1 to 20. This counts maps, not metres."
        },
        "exclude": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Seeds not to find again, for example the maps already in the rotation. At most 100 are read."
        },
        "worldSize": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The world size of the candidates in metres, 1000 to 6000."
        }
      },
      "type": "object",
      "description": "A request for candidate maps (Find maps): how many maps at which size."
    },
    "CreateFolderRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the host is offline; leave it out to refuse."
            }
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The new folder's name, up to 64 characters. On a Linux host letters, digits, `.`, `_` and `-`; on a Windows host any name Windows accepts except one with `%`."
        },
        "parent": {
          "type": [
            "null",
            "string"
          ],
          "description": "The existing folder to create it in, an absolute path on the host."
        },
        "serverId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The server on this host whose backup folder is being chosen (`srv_...`). With it, a member who may manage that server's backups may make a folder without the right to add servers. Leave it out otherwise."
        }
      },
      "type": "object",
      "description": "Creates one new, empty folder inside an existing folder on a host."
    },
    "CreateInvitationBody": {
      "properties": {
        "email": {
          "type": "string",
          "description": "One plain email address."
        },
        "hosts": {
          "items": {
            "$ref": "#/$defs/HostAccessBody"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The hosts the person may see, read-only (status, last seen, version, and the servers on it they may see). Optional: leave it out for none. Not for a person whose role for the whole workspace already has everything."
        },
        "servers": {
          "items": {
            "$ref": "#/$defs/ServerAccessBody"
          },
          "type": "array",
          "description": "The roles on single servers, at most one per server; empty when the role for the whole workspace is enough. Always sent."
        },
        "workspaceRoleId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The role for the whole workspace, or null for a person who is invited to servers only. Always sent."
        }
      },
      "required": [
        "email",
        "workspaceRoleId",
        "servers"
      ],
      "type": "object",
      "description": "Invite a person by email."
    },
    "CreatePlayerNoteRequestBody": {
      "properties": {
        "body": {
          "type": "string",
          "description": "The note: 1 to 2000 characters. Line breaks are kept; other control characters are refused."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the player, kept with the note so the list reads when the player is away; optional, up to 64 characters."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID of the player the note is about, 17 digits. The player does not have to be connected."
        }
      },
      "required": [
        "steamId",
        "body"
      ],
      "type": "object",
      "description": "Writes a private note about a player."
    },
    "CreateWorkspaceRequestBody": {
      "properties": {
        "name": {
          "type": "string",
          "description": "The workspace name members see, at most 64 characters with no line breaks or hidden characters (else `too_long` or `control_character`). Leading and trailing spaces are removed."
        }
      },
      "required": [
        "name"
      ],
      "type": "object",
      "description": "Create a workspace. The caller becomes its Owner."
    },
    "CreatedApiKeyResponse": {
      "properties": {
        "key": {
          "$ref": "#/$defs/ApiKeyResponse"
        },
        "secret": {
          "type": [
            "null",
            "string"
          ],
          "description": "The key text to send as `Authorization: Bearer ...`. Shown only here, once. Null when the same request was repeated with\nthe same Idempotency-Key: revoke that key and make another."
        }
      },
      "required": [
        "key",
        "secret"
      ],
      "type": "object",
      "description": "A key that was just made."
    },
    "CurrentMeasurementResponse": {
      "properties": {
        "freshness": {
          "type": "string"
        },
        "observedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "value": {
          "format": "double",
          "type": [
            "null",
            "number"
          ]
        }
      },
      "required": [
        "value",
        "observedAt",
        "freshness"
      ],
      "type": "object",
      "description": "A last raw observation; null fields mean no sample, not zero."
    },
    "CustomerNoticePageResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/CustomerNoticeResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "items",
        "nextCursor"
      ],
      "type": "object"
    },
    "CustomerNoticeResponse": {
      "properties": {
        "body": {
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "subject": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "subject",
        "body",
        "createdAt"
      ],
      "type": "object"
    },
    "DashboardAvailability": {
      "properties": {
        "hosts": {
          "type": "boolean"
        },
        "incidents": {
          "type": "boolean"
        },
        "performance": {
          "type": "boolean"
        },
        "players": {
          "type": "boolean"
        },
        "servers": {
          "type": "boolean"
        }
      },
      "required": [
        "hosts",
        "servers",
        "players",
        "incidents",
        "performance"
      ],
      "type": "object"
    },
    "DashboardCount": {
      "properties": {
        "connected": {
          "format": "int32",
          "type": "integer"
        },
        "total": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "total",
        "connected"
      ],
      "type": "object"
    },
    "DashboardCounts": {
      "properties": {
        "hosts": {
          "$ref": "#/$defs/DashboardCount"
        },
        "incidents": {
          "$ref": "#/$defs/DashboardIncidents"
        },
        "players": {
          "$ref": "#/$defs/DashboardPlayers"
        },
        "servers": {
          "$ref": "#/$defs/DashboardServerCount"
        }
      },
      "required": [
        "hosts",
        "servers",
        "players",
        "incidents"
      ],
      "type": "object"
    },
    "DashboardCoverage": {
      "properties": {
        "eligible": {
          "format": "int32",
          "type": "integer"
        },
        "measured": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "measured",
        "eligible"
      ],
      "type": "object"
    },
    "DashboardCoverages": {
      "properties": {
        "fps": {
          "$ref": "#/$defs/DashboardCoverage"
        },
        "players": {
          "$ref": "#/$defs/DashboardCoverage"
        },
        "servers": {
          "$ref": "#/$defs/DashboardCoverage"
        }
      },
      "required": [
        "servers",
        "players",
        "fps"
      ],
      "type": "object"
    },
    "DashboardIncidents": {
      "properties": {
        "active": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "active"
      ],
      "type": "object"
    },
    "DashboardItem": {
      "anyOf": [
        {
          "$ref": "#/$defs/DashboardItemDashboardHostRow"
        },
        {
          "$ref": "#/$defs/DashboardItemDashboardServerRow"
        }
      ],
      "discriminator": {
        "propertyName": "$type"
      },
      "type": "object"
    },
    "DashboardItemDashboardHostRow": {
      "properties": {
        "connection": {
          "type": "string"
        },
        "cpu": {
          "$ref": "#/$defs/CurrentMeasurementResponse"
        },
        "id": {
          "type": "string"
        },
        "memory": {
          "$ref": "#/$defs/HostMemoryResponse"
        },
        "name": {
          "type": "string"
        },
        "supported": {
          "type": "boolean"
        },
        "volumeCoverage": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/HostVolumeCoverage"
            }
          ]
        },
        "volumes": {
          "items": {
            "$ref": "#/$defs/HostVolumeResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "id",
        "name",
        "connection",
        "cpu",
        "memory",
        "volumes",
        "supported",
        "volumeCoverage"
      ]
    },
    "DashboardItemDashboardServerRow": {
      "properties": {
        "fps": {
          "$ref": "#/$defs/CurrentMeasurementResponse"
        },
        "hostId": {
          "type": "string"
        },
        "hostName": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "players": {
          "$ref": "#/$defs/CurrentMeasurementResponse"
        },
        "state": {
          "type": "string"
        },
        "supported": {
          "type": "boolean"
        }
      },
      "required": [
        "id",
        "name",
        "hostId",
        "hostName",
        "state",
        "players",
        "fps",
        "supported"
      ]
    },
    "DashboardItemsResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/DashboardItem"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "items",
        "nextCursor"
      ],
      "type": "object"
    },
    "DashboardPerformance": {
      "properties": {
        "available": {
          "type": "boolean"
        },
        "bucketSeconds": {
          "format": "int32",
          "type": "integer"
        },
        "from": {
          "format": "date-time",
          "type": "string"
        },
        "range": {
          "type": "string"
        },
        "series": {
          "items": {
            "$ref": "#/$defs/DashboardSeries"
          },
          "type": "array"
        },
        "to": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "available",
        "range",
        "from",
        "to",
        "bucketSeconds",
        "series"
      ],
      "type": "object"
    },
    "DashboardPlayers": {
      "properties": {
        "eligible": {
          "format": "int32",
          "type": "integer"
        },
        "measured": {
          "format": "int32",
          "type": "integer"
        },
        "value": {
          "format": "double",
          "type": [
            "null",
            "number"
          ]
        }
      },
      "required": [
        "value",
        "measured",
        "eligible"
      ],
      "type": "object"
    },
    "DashboardPoint": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": "string"
        },
        "average": {
          "format": "double",
          "type": "number"
        },
        "eligible": {
          "format": "int32",
          "type": "integer"
        },
        "maximum": {
          "format": "double",
          "type": "number"
        },
        "measured": {
          "format": "int32",
          "type": "integer"
        },
        "minimum": {
          "format": "double",
          "type": "number"
        },
        "samples": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "at",
        "samples",
        "average",
        "minimum",
        "maximum",
        "measured",
        "eligible"
      ],
      "type": "object"
    },
    "DashboardResponse": {
      "properties": {
        "availability": {
          "$ref": "#/$defs/DashboardAvailability"
        },
        "counts": {
          "$ref": "#/$defs/DashboardCounts"
        },
        "coverage": {
          "$ref": "#/$defs/DashboardCoverages"
        },
        "observedAt": {
          "format": "date-time",
          "type": "string"
        },
        "performance": {
          "$ref": "#/$defs/DashboardPerformance"
        }
      },
      "required": [
        "observedAt",
        "counts",
        "performance",
        "coverage",
        "availability"
      ],
      "type": "object"
    },
    "DashboardSeries": {
      "properties": {
        "coverage": {
          "$ref": "#/$defs/DashboardCoverage"
        },
        "metric": {
          "type": "string"
        },
        "points": {
          "items": {
            "$ref": "#/$defs/DashboardPoint"
          },
          "type": "array"
        },
        "unit": {
          "type": "string"
        }
      },
      "required": [
        "metric",
        "unit",
        "points",
        "coverage"
      ],
      "type": "object"
    },
    "DashboardServerCount": {
      "properties": {
        "running": {
          "format": "int32",
          "type": "integer"
        },
        "total": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "total",
        "running"
      ],
      "type": "object"
    },
    "DeleteBackupBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        }
      },
      "type": "object",
      "description": "Delete one backup: only the optional admission choices."
    },
    "DeletionWaitResponse": {
      "properties": {
        "reason": {
          "type": "string",
          "description": "`owner` (an owner closed the workspace) or `account_deletion` (its only member deleted their account)."
        },
        "requestedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the deletion was asked for."
        }
      },
      "required": [
        "requestedAt",
        "reason"
      ],
      "type": "object"
    },
    "DeliverUploadBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        }
      },
      "type": "object",
      "description": "Send a finished upload to the server's host."
    },
    "DeviceSessionListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/DeviceSessionResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ]
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount"
      ],
      "type": "object"
    },
    "DeviceSessionResponse": {
      "properties": {
        "absoluteExpiresAt": {
          "format": "date-time",
          "type": "string"
        },
        "address": {
          "type": [
            "null",
            "string"
          ],
          "description": "The sign-in address with its last part hidden, for example `203.0.113.x`."
        },
        "appVersion": {
          "type": [
            "null",
            "string"
          ],
          "description": "The app's version as it stated it when this device signed in, for example `1.4.0`. Null for devices that signed in before this existed."
        },
        "country": {
          "type": [
            "null",
            "string"
          ],
          "description": "The two-letter country of the sign-in address, for example `AU`. Approximate; null when unknown."
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "current": {
          "type": "boolean"
        },
        "deviceKind": {
          "type": [
            "null",
            "string"
          ],
          "description": "`phone`, `tablet` or `unknown`."
        },
        "deviceModel": {
          "type": [
            "null",
            "string"
          ],
          "description": "The model the app stated, for example `iPhone15,2` or `Pixel 8`."
        },
        "expiresAt": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "lastSeenAt": {
          "format": "date-time",
          "type": "string"
        },
        "osVersion": {
          "type": [
            "null",
            "string"
          ],
          "description": "The system version, for example `17.4`."
        },
        "platform": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "platform",
        "createdAt",
        "lastSeenAt",
        "expiresAt",
        "absoluteExpiresAt",
        "current"
      ],
      "type": "object",
      "description": "A native device authorization owned by the signed-in account."
    },
    "DiscordBanOptionResponse": {
      "properties": {
        "banned": {
          "type": "boolean",
          "description": "True when RustSC made a Discord ban on this player that is still in place, so an unban can offer to lift it (also when the player's link is gone)."
        },
        "offered": {
          "type": "boolean",
          "description": "True when the choice may be shown and used."
        },
        "problem": {
          "type": [
            "null",
            "string"
          ],
          "description": "`needs_permission` when the RustSC bot lacks Ban Members in Discord; left out otherwise."
        }
      },
      "required": [
        "offered"
      ],
      "type": "object",
      "description": "Whether the choice \"Also ban from Discord\" is offered for a player."
    },
    "DiscordBanPlayerBody": {
      "properties": {
        "deleteMessageSeconds": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Whose recent messages to delete, in seconds: 0 (the default), 3600, 21600, 43200, 86400, 259200 or 604800."
        },
        "steamId": {
          "type": "string",
          "description": "The player's Steam ID (17 digits)."
        }
      },
      "required": [
        "steamId"
      ],
      "type": "object"
    },
    "DiscordBanResponse": {
      "properties": {
        "outcome": {
          "type": "string",
          "description": "`banned`, `needs_permission`, `move_role`, `no_account`, `busy` or `unavailable`."
        }
      },
      "required": [
        "outcome"
      ],
      "type": "object"
    },
    "DiscordBoardBody": {
      "properties": {
        "changeChannelId": {
          "type": [
            "null",
            "string"
          ],
          "description": "A separate channel for the change posts, from the same list. Absent keeps the saved one; an empty text posts them in the board's channel; a channel posts them there. Checked like `channelId`."
        },
        "changePosts": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Post a short new message when the server changes state. Default true."
        },
        "channelId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The channel's Discord ID, from the list of `listDiscordPostChannels`. Required the first time; absent later keeps the saved channel; a different one starts the board fresh in it. Checked again against the workspace's own connected Discord server."
        },
        "columns": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/DiscordColumnsBody",
              "description": "The columns beside the player's name in the list. Absent or null is no choice: the standard columns, which change with RustSC\n(Country and Ping once Country is available, Ping until then). Send both places to choose; `null` for a place is no column there."
            }
          ]
        },
        "joinAddress": {
          "type": [
            "null",
            "string"
          ],
          "description": "The address players type to join, for example `play.example.com:28015`; absent shows none."
        },
        "look": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/DiscordLookBody",
              "description": "The server's own look on the posts; absent or empty uses the server's name and the RustSC icon."
            }
          ]
        },
        "mapName": {
          "type": [
            "null",
            "string"
          ],
          "description": "Ignored. Kept so older clients keep working. The Map fact always shows the server's map name from its Map settings."
        },
        "playerList": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Show the names of the players online in that message. Default true."
        },
        "playerSort": {
          "type": [
            "null",
            "string"
          ],
          "description": "How the list is sorted: `name` (A to Z, the default) or `time` (longest connected this session first)."
        },
        "refreshMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Deprecated and ignored. Kept so older clients keep working. The status message is updated at most once a minute, and only when it changed."
        },
        "showFps": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Whether the status message shows the server's frame rate as a number (for example `62 FPS`), as of the last time a player joined or left or the status changed. Absent or null is no choice, which is off today and\ncan change with RustSC; send `true` to show it or `false` to keep it off."
        },
        "showMap": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Whether the status message shows the server's map name. Absent or null keeps what the board has (a new board starts with it off)."
        },
        "showWiped": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Whether the status message shows when the server was last wiped. Absent or null keeps what the board has (a new board starts with it off)."
        },
        "statusBoard": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Keep one live status message in the channel, edited in place. Default true."
        }
      },
      "type": "object",
      "description": "A server's Discord settings to store (`PUT` replaces them all; an absent switch takes its default, which is on). The board is posted in a channel of\nthe workspace's connected Discord server by the RustSC bot."
    },
    "DiscordBoardResponse": {
      "properties": {
        "boardPosted": {
          "type": "boolean",
          "description": "Whether the board's message exists in the channel."
        },
        "brandIconUrl": {
          "type": "string",
          "description": "The RustSC icon address used at the top right, in the footer when a logo replaces it there, and as the default sender picture."
        },
        "changeChannelId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The separate channel the change posts go to; null posts them in the board's channel."
        },
        "changeChannelName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The separate change channel's name in Discord, without the #; null while none is saved."
        },
        "changePosts": {
          "type": "boolean"
        },
        "channelId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The Discord channel the bot posts in; null while no channel is saved."
        },
        "channelName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The channel's name in Discord when it was picked, without the #; null while no channel is saved."
        },
        "columns": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/DiscordColumnsResponse",
              "description": "The columns the member chose, or null when they made no choice and the standard columns apply."
            }
          ]
        },
        "connected": {
          "type": "boolean",
          "description": "Whether a channel is saved."
        },
        "countryAvailable": {
          "type": "boolean",
          "description": "Whether the Country column can be chosen. Always true since the country lookup shipped (25 October 2026); kept so older clients keep working."
        },
        "countryDataMonth": {
          "type": [
            "null",
            "string"
          ],
          "description": "The release month (`YYYY-MM`, for example `2026-10`) of the country data the host used for the newest report, or null when the host has none (yet) or has not reported the player list."
        },
        "effectiveColumns": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The columns beside the name that the list shows now, in order: the member's choice, or the standard columns."
        },
        "fpsShown": {
          "type": "boolean",
          "description": "Whether the status message shows the server FPS now: the member's choice, or off when there is none."
        },
        "joinAddress": {
          "type": [
            "null",
            "string"
          ]
        },
        "lastPostedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The last time Discord took a post or an edit, UTC; null before the first."
        },
        "look": {
          "$ref": "#/$defs/DiscordLookResponse"
        },
        "mapName": {
          "type": [
            "null",
            "string"
          ],
          "description": "Ignored and always null. Kept so older clients keep working. The Map fact always shows the server's map name from its Map settings."
        },
        "needsReconnect": {
          "type": "boolean",
          "description": "True when the board has no channel yet and posts nothing until one is picked (it was saved with a link before the bot became the only way to post)."
        },
        "playerList": {
          "type": "boolean"
        },
        "playerSort": {
          "type": "string",
          "description": "`name` or `time`."
        },
        "problem": {
          "type": [
            "null",
            "string"
          ],
          "description": "The problem the last look had, as a stable code: `no_bot`, `cannot_post`, `channel_gone`, `unauthorized`, `bad_request`, `unreachable`, `service_error`, `rate_limited` or `other`; null while everything works."
        },
        "problemAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "refreshMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Deprecated: always null. The status message is updated at most once a minute, and only when it changed."
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "Raised by every save that changes something; 0 means never saved."
        },
        "showFps": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "What the member chose for the server FPS: true, false, or null when they made no choice."
        },
        "showMap": {
          "type": "boolean",
          "description": "Whether the status message shows the server's map name now."
        },
        "showWiped": {
          "type": "boolean",
          "description": "Whether the status message shows when the server was last wiped now."
        },
        "statusBoard": {
          "type": "boolean"
        },
        "updatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "connected",
        "channelId",
        "channelName",
        "needsReconnect",
        "statusBoard",
        "playerList",
        "changePosts",
        "look",
        "joinAddress",
        "columns",
        "effectiveColumns",
        "playerSort",
        "showFps",
        "refreshMinutes",
        "fpsShown",
        "showMap",
        "showWiped",
        "mapName",
        "countryAvailable",
        "countryDataMonth",
        "problem",
        "problemAt",
        "lastPostedAt",
        "boardPosted",
        "brandIconUrl",
        "revision",
        "updatedAt"
      ],
      "type": "object",
      "description": "A server's Discord settings and how they are working."
    },
    "DiscordColumnsBody": {
      "properties": {
        "second": {
          "type": [
            "null",
            "string"
          ],
          "description": "One of `country`, `ping`, `session`, `wipe`, `total`, or null for none."
        },
        "third": {
          "type": [
            "null",
            "string"
          ],
          "description": "One of `country`, `ping`, `session`, `wipe`, `total`, or null for none; not the same as the second."
        }
      },
      "type": "object",
      "description": "The two optional columns beside the player's name. A column can be chosen once; the name column is always shown."
    },
    "DiscordColumnsResponse": {
      "properties": {
        "second": {
          "type": [
            "null",
            "string"
          ]
        },
        "third": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "second",
        "third"
      ],
      "type": "object"
    },
    "DiscordInstallResponse": {
      "properties": {
        "url": {
          "type": "string"
        }
      },
      "required": [
        "url"
      ],
      "type": "object",
      "description": "The address of Discord's own page that adds the bot to a server. It carries a signed state that is valid for 30 minutes and only for the member who asked."
    },
    "DiscordLinkBotResponse": {
      "properties": {
        "bannerUrl": {
          "type": [
            "null",
            "string"
          ],
          "description": "Discord's address of the banner, or null."
        },
        "bio": {
          "type": [
            "null",
            "string"
          ],
          "description": "The bio RustSC set (at most 300 characters), or null."
        },
        "included": {
          "type": "boolean"
        },
        "nickname": {
          "type": [
            "null",
            "string"
          ]
        },
        "pictureUrl": {
          "type": [
            "null",
            "string"
          ],
          "description": "Discord's address of the picture, or null."
        }
      },
      "required": [
        "included"
      ],
      "type": "object"
    },
    "DiscordLinkLookResponse": {
      "properties": {
        "accentColor": {
          "type": [
            "null",
            "string"
          ],
          "description": "`#RRGGBB`, or null for the default colour."
        },
        "bannerUrl": {
          "type": [
            "null",
            "string"
          ]
        },
        "displayName": {
          "type": [
            "null",
            "string"
          ]
        },
        "logoUrl": {
          "type": [
            "null",
            "string"
          ]
        },
        "serverId": {
          "type": "string",
          "description": "The server whose Discord settings hold this look (the portal links to them)."
        }
      },
      "required": [
        "serverId"
      ],
      "type": "object",
      "description": "The server's own look in Discord as the link message uses it."
    },
    "DiscordLinkMessageResponse": {
      "properties": {
        "defaultBannerUrl": {
          "type": [
            "null",
            "string"
          ],
          "description": "The banner shown when the look has none (a wide, short strip, 1200 by 200 pixels); null when this deployment has no picture addresses."
        },
        "iconUrl": {
          "type": [
            "null",
            "string"
          ],
          "description": "The RustSC icon address (the thumbnail at the top right when the look has no logo, else the footer icon); null when this deployment has no picture addresses."
        },
        "look": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/DiscordLinkLookResponse",
              "description": "The look of the workspace's first server that has one, or null for the default look."
            }
          ]
        }
      },
      "type": "object",
      "description": "What the pinned instruction message is made of: the RustSC icon (top right, and the footer when a logo replaces it) and default banner addresses, and the look the member set\nin a server's Discord settings. The message shows the look when there is one and the default banner otherwise; the footer is always\nthere and cannot be changed."
    },
    "DiscordLinkNicknameProblemResponse": {
      "properties": {
        "count": {
          "format": "int32",
          "type": "integer"
        },
        "reason": {
          "type": "string"
        }
      },
      "required": [
        "reason",
        "count"
      ],
      "type": "object",
      "description": "`reason` is `role_above` (the player's role is above the bot's), `server_owner`, `no_permission` (the bot lacks Manage Nicknames), `not_in_server` or `unavailable` (Discord did not answer)."
    },
    "DiscordLinkNicknamesResponse": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "problems": {
          "items": {
            "$ref": "#/$defs/DiscordLinkNicknameProblemResponse"
          },
          "type": "array",
          "description": "Players who could not be renamed, one entry per reason, only reasons with at least one player."
        },
        "renamed": {
          "format": "int32",
          "type": "integer"
        },
        "waiting": {
          "format": "int32",
          "type": "integer",
          "description": "Players whose nickname waits to be changed (a backlog changes a few at a time)."
        }
      },
      "required": [
        "enabled",
        "waiting",
        "renamed",
        "problems"
      ],
      "type": "object",
      "description": "\"Set linked players' Discord nickname to their Steam name\": the setting, the players whose\nnickname is waiting to be changed, the players renamed, and the players who could not be renamed, by reason."
    },
    "DiscordLinkResponse": {
      "properties": {
        "available": {
          "type": "boolean",
          "description": "False when this deployment has no Discord bot configured; then nothing here works."
        },
        "bot": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/DiscordLinkBotResponse",
              "description": "The bot's name and picture in the connected Discord server."
            }
          ]
        },
        "channelId": {
          "type": [
            "null",
            "string"
          ]
        },
        "channelName": {
          "type": [
            "null",
            "string"
          ]
        },
        "command": {
          "type": [
            "null",
            "string"
          ],
          "description": "The command players type in the game, without the slash; `link` unless the workspace renamed it."
        },
        "commandsState": {
          "type": [
            "null",
            "string"
          ],
          "description": "`needs_permission` when Discord refused to add the `/link` command to the server (add the bot to Discord again), else null."
        },
        "findRoles": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The Discord role IDs the workspace lets use `/link search` besides people with Manage Server; empty until a choice is saved, which is Manage Server only."
        },
        "guildName": {
          "type": [
            "null",
            "string"
          ]
        },
        "inviteUrl": {
          "type": [
            "null",
            "string"
          ],
          "description": "The Discord invite link players see in the game, or null."
        },
        "links": {
          "format": "int32",
          "type": "integer",
          "description": "How many players are linked in this workspace."
        },
        "message": {
          "$ref": "#/$defs/DiscordLinkMessageResponse",
          "description": "What the instruction message in the link channel is made of, for the preview."
        },
        "nicknames": {
          "$ref": "#/$defs/DiscordLinkNicknamesResponse",
          "description": "The nickname sync: the setting and what it has done."
        },
        "status": {
          "type": "string"
        },
        "statusDetail": {
          "type": [
            "null",
            "string"
          ]
        },
        "wording": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/DiscordLinkWordingResponse",
              "description": "The community's own words for the link; null parts are RustSC's defaults."
            }
          ]
        }
      },
      "required": [
        "available",
        "status",
        "links",
        "message",
        "nicknames",
        "findRoles"
      ],
      "type": "object",
      "description": "The Discord link setup of a workspace. `status` is `none` (no Discord\nserver connected), `connected` (the bot is in the server, no link channel yet), `ready`, `channel_gone` (the link channel\nwas deleted) or `needs_permission` (`statusDetail` names what the bot is missing)."
    },
    "DiscordLinkWordingResponse": {
      "properties": {
        "linkedReply": {
          "type": [
            "null",
            "string"
          ]
        },
        "title": {
          "type": [
            "null",
            "string"
          ]
        },
        "welcome": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object",
      "description": "The community's own words: the title of the pinned message (at most 80 characters), a welcome\nline above its steps (at most 300) and a line under \"Linked to...\" in the reply after linking (at most 200). Null is RustSC's default."
    },
    "DiscordLookBody": {
      "properties": {
        "accentColor": {
          "type": [
            "null",
            "string"
          ],
          "description": "The board's colour bar as `#RRGGBB`; absent keeps green, amber and red for the server's state."
        },
        "bannerUrl": {
          "type": [
            "null",
            "string"
          ],
          "description": "A public `https` picture address shown at the bottom of the board. Discord scales it to the width of the message, so a wide, short picture (1200 by 200 pixels) works best."
        },
        "displayName": {
          "type": [
            "null",
            "string"
          ],
          "description": "Shown as the post's title and as the sender name (at most 80 characters; Discord refuses \"clyde\" and \"discord\" in a sender name)."
        },
        "logoUrl": {
          "type": [
            "null",
            "string"
          ],
          "description": "A public `https` picture address: the sender picture and the small picture at the top right. Absent shows the RustSC icon in both places."
        }
      },
      "type": "object",
      "description": "The server's own look on Discord posts. The footer \"rustsc.com\" is always shown and is not part of it."
    },
    "DiscordLookResponse": {
      "properties": {
        "accentColor": {
          "type": [
            "null",
            "string"
          ],
          "description": "`#RRGGBB`, or null for the state colours."
        },
        "bannerUrl": {
          "type": [
            "null",
            "string"
          ]
        },
        "displayName": {
          "type": [
            "null",
            "string"
          ]
        },
        "logoUrl": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "displayName",
        "logoUrl",
        "accentColor",
        "bannerUrl"
      ],
      "type": "object"
    },
    "DiscordMentionWire": {
      "properties": {
        "kind": {
          "type": "string",
          "description": "`none`, `role`, `everyone` or `here`."
        },
        "roleId": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `role`: the role's Discord ID (17 to 20 digits)."
        },
        "roleName": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `role`: the role's name, shown on the screen only."
        }
      },
      "required": [
        "kind"
      ],
      "type": "object",
      "description": "Who the post pings: nobody, one role, `@everyone` or `@here`. Only what is chosen here can ping."
    },
    "DiscordPostTestBody": {
      "properties": {
        "channel": {
          "type": "string",
          "description": "The Discord channel to post in (`rte_`)."
        }
      },
      "required": [
        "channel"
      ],
      "type": "object",
      "description": "Posts an alert's card once in one Discord channel, filled in with example values."
    },
    "DiscordPostTestResponse": {
      "properties": {
        "problem": {
          "type": [
            "null",
            "string"
          ]
        },
        "sent": {
          "type": "boolean"
        }
      },
      "required": [
        "sent",
        "problem"
      ],
      "type": "object",
      "description": "Whether the test post was sent, or the stable problem: `webhook_gone`, `unreachable`, `link_unreadable`, `bad_request`, `rate_limited`, `no_link`, `test_busy`."
    },
    "DiscordPostWire": {
      "properties": {
        "color": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "A card's colour bar as a number from 0 to 16777215 (0xRRGGBB). Left out for Discord's own grey."
        },
        "footer": {
          "type": [
            "null",
            "string"
          ],
          "description": "A card's footer, up to 2,048 characters; fill-in values allowed."
        },
        "mention": {
          "$ref": "#/$defs/DiscordMentionWire"
        },
        "showTime": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "On a card, show when it happened beside the footer, in each reader's own time zone."
        },
        "style": {
          "type": "string"
        },
        "title": {
          "type": [
            "null",
            "string"
          ],
          "description": "A card's title, up to 256 characters; fill-in values allowed. Left out on a message."
        },
        "variations": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "1 to 20 texts. Each send picks one at random and never the one sent last time. A message text is at most 2,000 characters with its mention; a card text at most 4,096."
        }
      },
      "required": [
        "style",
        "mention",
        "variations"
      ],
      "type": "object",
      "description": "A Discord post in the member's own words. Each text of `variations` may use fill-in values such as `{server_name}`, `{wipe_type}` and\n`{event_time}` (`{event_time:relative}` says \"2 minutes ago\"). A text never pings anyone (`@everyone`, `@here` and `&lt;@` are refused\nas `unsafe_mention`); `mention` is the only ping."
    },
    "DiscordTestBody": {
      "properties": {
        "channelId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The channel to test, for example one just picked and not yet saved."
        }
      },
      "type": "object",
      "description": "Posts one test message. Absent `channelId` uses the saved channel."
    },
    "DiscordTestResponse": {
      "properties": {
        "missing": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "For `cannot_post`: what the bot lacks in the channel (`View Channel`, `Send Messages`, `Embed Links`); otherwise empty."
        },
        "problem": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why not: the codes of string? DiscordBoardResponse.Problem and `reconnect` (no channel yet); null when sent."
        },
        "sent": {
          "type": "boolean"
        }
      },
      "required": [
        "sent",
        "problem",
        "missing"
      ],
      "type": "object",
      "description": "Whether Discord took the test message."
    },
    "DiscordUnbanPlayerBody": {
      "properties": {
        "steamId": {
          "type": "string",
          "description": "The player's Steam ID (17 digits)."
        }
      },
      "required": [
        "steamId"
      ],
      "type": "object"
    },
    "DiscordUnbanResponse": {
      "properties": {
        "outcome": {
          "type": "string",
          "description": "`unbanned`, `needs_permission`, `busy` or `unavailable`."
        }
      },
      "required": [
        "outcome"
      ],
      "type": "object"
    },
    "DisplayLimitResponse": {
      "properties": {
        "limit": {
          "format": "int32",
          "type": "integer",
          "description": "The most the server list keeps, in string DisplayLimitResponse.Unit."
        },
        "unit": {
          "type": "string",
          "description": "`utf8_bytes` or `utf16_units`. Treat unknown values as other."
        }
      },
      "required": [
        "unit",
        "limit"
      ],
      "type": "object",
      "description": "Where the server list cuts a text."
    },
    "DroppedPluginBody": {
      "properties": {
        "addAnyway": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True to add a file that was flagged (a downgrade, a version that cannot be read or compared)."
        },
        "fileName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The plugin file name, such as `CargoTrainEvent.cs`."
        },
        "sha256": {
          "type": [
            "null",
            "string"
          ],
          "description": "Lowercase hexadecimal fingerprint of the file."
        },
        "size": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ]
        },
        "version": {
          "type": [
            "null",
            "string"
          ],
          "description": "The version in the file's header; leave it out when the header could not be read."
        }
      },
      "type": "object",
      "description": "A file the member dropped, as the browser read it."
    },
    "DuplicateTimedChangeBody": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The new name; left out, \"`name` copy\"."
        }
      },
      "type": "object",
      "description": "Make a new temporary change with the same files and settings. It starts paused."
    },
    "DuplicateWipeBody": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The copy's name. Absent is the original's name and \" copy\"."
        }
      },
      "type": "object",
      "description": "The copy points at the same saved files, so it costs no space."
    },
    "EditPlayerNoteRequestBody": {
      "properties": {
        "body": {
          "type": "string",
          "description": "The new text, as for a new note."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the player now; optional. Left out, the name stored with the note stays."
        }
      },
      "required": [
        "body"
      ],
      "type": "object",
      "description": "Changes the text of a note. The `If-Match` header carries the revision that was read."
    },
    "EditServerFileBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "area": {
          "type": [
            "null",
            "string"
          ],
          "description": "Leave out for the Oxide or Carbon folder. `rustsc` saves a file in RustSC's folder of the server instead (the path starts with `rustsc`)."
        },
        "baseSha256": {
          "type": [
            "null",
            "string"
          ],
          "description": "The `sha256` the read of the file returned: the revision this edit started from. A file that changed since is refused."
        },
        "content": {
          "type": [
            "null",
            "string"
          ],
          "description": "The whole new text, saved exactly as sent."
        },
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "`oxide` or `carbon`."
        },
        "path": {
          "type": [
            "null",
            "string"
          ],
          "description": "The file, as the folder listing named it."
        },
        "reload": {
          "type": "boolean",
          "description": "True to reload the plugin the file belongs to after saving."
        }
      },
      "type": "object",
      "description": "A save of one file in the framework's folder of a server."
    },
    "EditSharedPermissionsBody": {
      "properties": {
        "edits": {
          "items": {
            "$ref": "#/$defs/SharedEditBody"
          },
          "type": "array"
        }
      },
      "required": [
        "edits"
      ],
      "type": "object",
      "description": "All or nothing."
    },
    "EmailChallengeResponse": {
      "properties": {
        "challengeId": {
          "type": "string",
          "description": "Send this with the code to verify it, for example `ech_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "expiresAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the code stops working."
        },
        "resendAvailableAt": {
          "format": "date-time",
          "type": "string",
          "description": "The earliest time another code can be requested for this address."
        }
      },
      "required": [
        "challengeId",
        "expiresAt",
        "resendAvailableAt"
      ],
      "type": "object",
      "description": "A sign-in code was sent. The response is the same whether or not the address already has an account."
    },
    "EmailSignInStartRequest": {
      "properties": {
        "analytics": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/SignInAnalyticsRequest",
              "description": "Optional acquisition labels. Refusal never changes sign-in behavior."
            }
          ]
        },
        "email": {
          "type": "string",
          "description": "The email address to send the code to."
        },
        "requestId": {
          "format": "uuid",
          "type": [
            "null",
            "string"
          ],
          "description": "Optional UUIDv7 identity for this initial request or explicit resend. Send it together with resend. Keep both values unchanged after a lost response."
        },
        "resend": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "False for a new initial request and its retries; true for one explicit new resend with a new requestId. If the response is lost, repeat with the same requestId and value."
        }
      },
      "required": [
        "email"
      ],
      "type": "object",
      "description": "Ask for a sign-in code. The same request signs in to an existing account or starts a new one."
    },
    "EmailSignInVerifyRequest": {
      "properties": {
        "challengeId": {
          "type": "string",
          "description": "The `challengeId` returned when the code was requested."
        },
        "code": {
          "type": "string",
          "description": "The code from the email. Spaces and hyphens are ignored."
        },
        "privacyVersion": {
          "type": [
            "null",
            "string"
          ],
          "description": "The Privacy Policy version the page showed; see `termsVersion`."
        },
        "termsVersion": {
          "type": [
            "null",
            "string"
          ],
          "description": "Development and test sign-up by emailed code only: the Terms version the page showed when the person continued. Send it with\n`privacyVersion` (the current versions are in the sign-in options) and the account this code creates records the acceptance and the default\nproduct updates choice. Optional: a client written before the sign-up step existed leaves both out and still gets its account, with\nno acceptance recorded and product updates off. Ignored for an address that already has an account."
        }
      },
      "required": [
        "challengeId",
        "code"
      ],
      "type": "object",
      "description": "Verify an emailed sign-in code. A correct code signs the browser in."
    },
    "EndTemporaryAccessByReferenceBody": {
      "properties": {
        "reference": {
          "type": [
            "null",
            "string"
          ],
          "description": "The order reference used when it was given or when time was added with it. Required."
        }
      },
      "type": "object",
      "description": "End what an order reference gave (`POST .../temporary-access/actions/end-by-reference`)."
    },
    "EndpointBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "expectedRevision": {
          "format": "int64",
          "type": "integer"
        },
        "expectedScope": {
          "type": "string"
        },
        "ports": {
          "$ref": "#/$defs/EndpointPortsBody"
        }
      },
      "required": [
        "expectedScope",
        "expectedRevision",
        "ports"
      ],
      "type": "object"
    },
    "EndpointPortsBody": {
      "properties": {
        "game": {
          "format": "int32",
          "type": "integer"
        },
        "query": {
          "format": "int32",
          "type": "integer"
        },
        "rcon": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "game",
        "query",
        "rcon"
      ],
      "type": "object"
    },
    "EndpointResponse": {
      "properties": {
        "apply": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResponse"
            }
          ]
        },
        "canEdit": {
          "type": "boolean"
        },
        "canRestart": {
          "type": "boolean"
        },
        "connected": {
          "type": "boolean"
        },
        "installationId": {
          "type": [
            "null",
            "string"
          ]
        },
        "observation": {
          "type": "string"
        },
        "otherServers": {
          "items": {
            "$ref": "#/$defs/ServerPorts"
          },
          "type": "array",
          "description": "Ports the other servers of this host last confirmed (applied, and desired when different), without their identities."
        },
        "receivedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "refresh": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResponse"
            }
          ]
        },
        "save": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResponse"
            }
          ]
        },
        "sourceOperationId": {
          "type": [
            "null",
            "string"
          ]
        },
        "state": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/EndpointState"
            }
          ]
        },
        "supported": {
          "type": "boolean"
        }
      },
      "required": [
        "observation",
        "state",
        "installationId",
        "sourceOperationId",
        "receivedAt",
        "refresh",
        "save",
        "apply",
        "supported",
        "connected",
        "canEdit",
        "canRestart",
        "otherServers"
      ],
      "type": "object"
    },
    "EndpointState": {
      "properties": {
        "applied": {
          "$ref": "#/$defs/ServerPorts"
        },
        "appliedDocumentSha256": {
          "type": "string"
        },
        "appliedPlanSha256": {
          "type": "string"
        },
        "desired": {
          "$ref": "#/$defs/ServerPorts"
        },
        "operationId": {
          "type": "string"
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "scope": {
          "type": "string"
        }
      },
      "required": [
        "scope",
        "revision",
        "desired",
        "applied",
        "appliedDocumentSha256",
        "appliedPlanSha256",
        "operationId"
      ],
      "type": "object",
      "description": "Canonical host state."
    },
    "EnrollmentTokenListResponse": {
      "properties": {
        "installScriptUrl": {
          "type": [
            "null",
            "string"
          ],
          "description": "The https address of the host install script, for `curl -fsSL &lt;installScriptUrl&gt; | sudo bash` on a\nLinux host, or null when this service has no packages site configured."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/EnrollmentTokenResponse"
          },
          "type": "array",
          "description": "Unused, unexpired and unrevoked tokens."
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "The cursor of the next page, or null on the last page."
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Pending tokens on all pages."
        },
        "windowsInstallerUrl": {
          "type": [
            "null",
            "string"
          ],
          "description": "The https address of the Windows install script (`install.ps1`) that the PowerShell install command on a\nWindows host downloads, or null when this service has no packages site or Windows installer address configured."
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount",
        "installScriptUrl",
        "windowsInstallerUrl"
      ],
      "type": "object",
      "description": "Enrollment tokens that can still be used, newest first, one page at a time. Never their text."
    },
    "EnrollmentTokenResponse": {
      "properties": {
        "createdAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the token was created, UTC."
        },
        "expiresAt": {
          "format": "date-time",
          "type": "string",
          "description": "When an unused token stops working, UTC."
        },
        "hostId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The full host a replacement installation will join, or null for a token that adds a new host."
        },
        "id": {
          "type": "string",
          "description": "Token ID, for example `etok_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "installationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The installation a used token created, otherwise null."
        },
        "state": {
          "type": "string",
          "description": "`issued`, `used`, `expired` or `revoked`. Treat unknown values as other."
        },
        "token": {
          "type": [
            "null",
            "string"
          ],
          "description": "The token text, `rse_...`, in the response that created it. Null in every other\nresponse, including a repeat with the same `Idempotency-Key`: revoke that token and\ncreate another if the text was lost."
        }
      },
      "required": [
        "id",
        "token",
        "state",
        "hostId",
        "installationId",
        "createdAt",
        "expiresAt"
      ],
      "type": "object",
      "description": "An enrollment token. The token text is in `token` only in the response that created it;\nIt is shown once and can never be read again."
    },
    "EntityCountsResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "generation": {
          "type": "string",
          "description": "The world generation counted."
        },
        "groups": {
          "items": {
            "$ref": "#/$defs/EntityGroupCountResponse"
          },
          "type": "array",
          "description": "Every group with something in it, largest first."
        },
        "ownerSteamId": {
          "type": [
            "null",
            "string"
          ],
          "description": "Set when the count covered only this player's entities; absent for a whole-world count."
        },
        "prefabs": {
          "items": {
            "$ref": "#/$defs/EntityPrefabCountResponse"
          },
          "type": "array",
          "description": "The most common prefabs, largest first."
        },
        "total": {
          "format": "int32",
          "type": "integer",
          "description": "Every entity the game holds."
        }
      },
      "required": [
        "generation",
        "total",
        "groups",
        "prefabs"
      ],
      "type": "object"
    },
    "EntityDetailResponse": {
      "properties": {
        "authorized": {
          "items": {
            "$ref": "#/$defs/EntityPlayerResponse"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The players a cupboard authorizes; absent when the entity has no such list, never an empty list standing for unknown."
        },
        "buildingId": {
          "type": [
            "null",
            "string"
          ]
        },
        "contents": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many item stacks it holds; removing it removes them too."
        },
        "crateSecondsLeft": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Seconds until a hackable crate unlocks, 0 when it is unlocked."
        },
        "crateState": {
          "type": [
            "null",
            "string"
          ],
          "description": "A hackable crate's state: `locked`, `hacking` or `unlocked`; absent for anything else."
        },
        "displayName": {
          "type": "string",
          "description": "A name a person reads, for example Tool Cupboard."
        },
        "grade": {
          "type": [
            "null",
            "string"
          ],
          "description": "A building block's grade: twig, wood, stone, metal or top_tier."
        },
        "group": {
          "type": "string"
        },
        "healthPercent": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "locked": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True when a lock on it is locked. The code is never read."
        },
        "netId": {
          "type": "string"
        },
        "notRemovableReason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why not: `player` or `structure`."
        },
        "ownerName": {
          "type": [
            "null",
            "string"
          ]
        },
        "ownerSteamId": {
          "type": [
            "null",
            "string"
          ]
        },
        "prefab": {
          "type": "string"
        },
        "removable": {
          "type": "boolean",
          "description": "True when removing it is possible here."
        },
        "upkeepMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "A cupboard's protected time in whole minutes, as the game reports it."
        },
        "x": {
          "format": "int32",
          "type": "integer"
        },
        "y": {
          "format": "int32",
          "type": "integer"
        },
        "z": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "netId",
        "prefab",
        "group",
        "displayName",
        "x",
        "y",
        "z",
        "removable"
      ],
      "type": "object"
    },
    "EntityFindResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "entities": {
          "items": {
            "$ref": "#/$defs/EntityRowResponse"
          },
          "type": "array"
        },
        "generation": {
          "type": "string",
          "description": "The world generation searched."
        },
        "matched": {
          "format": "int32",
          "type": "integer",
          "description": "How many entities matched in the whole world; `entities` holds at most the first rows asked for."
        }
      },
      "required": [
        "generation",
        "matched",
        "entities"
      ],
      "type": "object"
    },
    "EntityGroupCountResponse": {
      "properties": {
        "count": {
          "format": "int32",
          "type": "integer"
        },
        "group": {
          "type": "string"
        }
      },
      "required": [
        "group",
        "count"
      ],
      "type": "object"
    },
    "EntityInspectResponse": {
      "properties": {
        "detail": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/EntityDetailResponse"
            }
          ]
        },
        "found": {
          "type": "boolean"
        },
        "generation": {
          "type": "string"
        },
        "reason": {
          "type": [
            "null",
            "string"
          ]
        },
        "revision": {
          "type": [
            "null",
            "string"
          ],
          "description": "What a removal must send back; it names this entity, its prefab and its owner."
        }
      },
      "required": [
        "found",
        "generation"
      ],
      "type": "object"
    },
    "EntityPlayerResponse": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "steamId": {
          "type": "string"
        }
      },
      "required": [
        "steamId"
      ],
      "type": "object"
    },
    "EntityPrefabCountResponse": {
      "properties": {
        "count": {
          "format": "int32",
          "type": "integer"
        },
        "group": {
          "type": "string"
        },
        "prefab": {
          "type": "string"
        }
      },
      "required": [
        "prefab",
        "group",
        "count"
      ],
      "type": "object"
    },
    "EntityRowResponse": {
      "properties": {
        "group": {
          "type": "string"
        },
        "healthPercent": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "netId": {
          "type": "string",
          "description": "The network ID, as text: keep it a string."
        },
        "ownerName": {
          "type": [
            "null",
            "string"
          ]
        },
        "ownerSteamId": {
          "type": [
            "null",
            "string"
          ]
        },
        "prefab": {
          "type": "string"
        },
        "x": {
          "format": "int32",
          "type": "integer",
          "description": "East of the map's centre, in whole metres."
        },
        "y": {
          "format": "int32",
          "type": "integer",
          "description": "Height in whole metres."
        },
        "z": {
          "format": "int32",
          "type": "integer",
          "description": "North of the map's centre, in whole metres."
        }
      },
      "required": [
        "netId",
        "prefab",
        "group",
        "x",
        "y",
        "z"
      ],
      "type": "object"
    },
    "ErasedEvidenceResponse": {
      "properties": {
        "categories": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The categories deleted; empty means every category."
        },
        "erasedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The moment: evidence stored up to it is no longer shown or exported. Null when this cloud keeps no evidence."
        }
      },
      "required": [
        "categories"
      ],
      "type": "object",
      "description": "What deleting a server's captured evidence covered."
    },
    "ErasedReportsResponse": {
      "properties": {
        "historyRows": {
          "format": "int32",
          "type": "integer",
          "description": "The notes and status changes that went with the reports."
        },
        "reports": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "reports",
        "historyRows"
      ],
      "type": "object",
      "description": "What erasing a player's reports removed."
    },
    "EvidenceCaptureBody": {
      "properties": {
        "enabled": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The names of the switches that are on. An unknown name is refused at `/enabled` as `unknown_value`; a switch that cannot be turned on yet as `not_available`."
        }
      },
      "type": "object",
      "description": "The switches to leave on; every other switch is turned off."
    },
    "EvidenceCaptureResponse": {
      "properties": {
        "canEdit": {
          "type": "boolean",
          "description": "True when the caller may change the switches (`servers.config.write`)."
        },
        "pluginInstalled": {
          "type": "boolean",
          "description": "True when the server's plugin list shows the RustSC plugin, which F7 reports and the system facts need; without it only the server's own chat broadcasts are recorded."
        },
        "restricted": {
          "type": "boolean"
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "0 while the accepted defaults apply; each save is the next revision."
        },
        "switches": {
          "items": {
            "$ref": "#/$defs/EvidenceSwitchResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "revision",
        "switches",
        "pluginInstalled",
        "canEdit",
        "restricted"
      ],
      "type": "object",
      "description": "What a server records of its own history. Only the switches whose source is built and verified are listed;\nthe others cannot be turned on. System facts (the server is ready, it is saving, the plugin unloaded) are recorded while any switch is on."
    },
    "EvidenceCountResponse": {
      "properties": {
        "category": {
          "type": "string"
        },
        "count": {
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "category",
        "count"
      ],
      "type": "object",
      "description": "How many events of one category a search matches."
    },
    "EvidenceDetailResponse": {
      "properties": {
        "context": {
          "items": {
            "$ref": "#/$defs/EvidenceItemResponse"
          },
          "type": "array",
          "description": "The events around it, oldest first, not repeating the event. The order is the order of occurrence, which is not a causal order."
        },
        "event": {
          "$ref": "#/$defs/EvidenceItemResponse"
        },
        "retentionDays": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "event",
        "context",
        "retentionDays"
      ],
      "type": "object",
      "description": "One recorded event with the events recorded just before and after it on the same server."
    },
    "EvidenceGapResponse": {
      "properties": {
        "categories": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "count": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many events are missing, when that is known."
        },
        "from": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "reason": {
          "type": "string",
          "description": "For example `replay_gap`, `load_tail_unconfirmed`, `rcon_disconnected`, `capture_stopped`, `intake_budget`, `rejected_payload` or `identity_conflict`."
        },
        "to": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "Null while the end is not known."
        }
      },
      "required": [
        "id",
        "reason",
        "categories",
        "from",
        "to",
        "count"
      ],
      "type": "object",
      "description": "A stretch of history that was not recorded. Missing data is shown as a gap, never as nothing happening."
    },
    "EvidenceItemResponse": {
      "properties": {
        "actor": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/EvidencePartyResponse"
            }
          ]
        },
        "category": {
          "type": "string",
          "description": "For example `chat.message`, `server.ready`, `server.saving` or `plugin.unloading`."
        },
        "delivery": {
          "type": "string",
          "description": "`live`, or `replay` for an event the host asked the plugin for after a break."
        },
        "id": {
          "type": "string"
        },
        "observation": {
          "$ref": "#/$defs/JsonElement",
          "description": "The category's fields as recorded. Text in it is untrusted: show it as text, never as markup or a command."
        },
        "occurredAt": {
          "format": "date-time",
          "type": "string",
          "description": "When it happened: the source's clock when it had one, otherwise the time the host received it."
        },
        "occurredAtBasis": {
          "type": "string",
          "description": "`source_clock`, `host_receipt` or `cloud_receipt`."
        },
        "source": {
          "type": "string",
          "description": "Where the event came from: `webrcon.chat`, `webrcon.console` or `companion`."
        },
        "subject": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/EvidencePartyResponse"
            }
          ]
        }
      },
      "required": [
        "id",
        "category",
        "occurredAt",
        "occurredAtBasis",
        "delivery",
        "source",
        "actor",
        "subject",
        "observation"
      ],
      "type": "object",
      "description": "One recorded event of a server."
    },
    "EvidencePageResponse": {
      "properties": {
        "available": {
          "type": "boolean",
          "description": "False when this cloud keeps no evidence; the page is then empty."
        },
        "captureRevision": {
          "format": "int64",
          "type": "integer",
          "description": "The server's switch revision now."
        },
        "capturing": {
          "type": "boolean",
          "description": "True when at least one switch is on, so the server is being recorded."
        },
        "gaps": {
          "items": {
            "$ref": "#/$defs/EvidenceGapResponse"
          },
          "type": "array"
        },
        "items": {
          "items": {
            "$ref": "#/$defs/EvidenceItemResponse"
          },
          "type": "array"
        },
        "next": {
          "type": [
            "null",
            "string"
          ],
          "description": "Pass as `before` to read the next page; null on the last page."
        },
        "retentionDays": {
          "format": "int32",
          "type": "integer",
          "description": "How many days evidence is kept."
        }
      },
      "required": [
        "available",
        "captureRevision",
        "capturing",
        "retentionDays",
        "items",
        "next",
        "gaps"
      ],
      "type": "object",
      "description": "One page of a server's recorded events, newest first, with the gaps that overlap it."
    },
    "EvidencePartyResponse": {
      "properties": {
        "kind": {
          "type": "string",
          "description": "`player`, `server` or `unknown`."
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "steamId": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "kind",
        "steamId",
        "name"
      ],
      "type": "object",
      "description": "A player or the server named by a record. A name is the player's label at the time and never an identity."
    },
    "EvidenceSearchItemResponse": {
      "properties": {
        "event": {
          "$ref": "#/$defs/EvidenceItemResponse"
        },
        "serverId": {
          "type": "string"
        },
        "serverName": {
          "type": "string",
          "description": "The server's name now; empty for a removed server."
        }
      },
      "required": [
        "serverId",
        "serverName",
        "event"
      ],
      "type": "object",
      "description": "One found event of a cross-server search, with the server it belongs to."
    },
    "EvidenceSearchResponse": {
      "properties": {
        "available": {
          "type": "boolean",
          "description": "False when this cloud keeps no evidence; the page is then empty."
        },
        "counts": {
          "items": {
            "$ref": "#/$defs/EvidenceCountResponse"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "How many events the whole search matches by category; given on the first page only (null after it) and only for events the caller may read."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/EvidenceSearchItemResponse"
          },
          "type": "array"
        },
        "next": {
          "type": [
            "null",
            "string"
          ],
          "description": "Pass as `before` to read the next page; null on the last page."
        },
        "retentionDays": {
          "format": "int32",
          "type": "integer",
          "description": "How many days evidence is kept: older events are never searched."
        },
        "searched": {
          "format": "int32",
          "type": "integer",
          "description": "How many servers were searched. Zero means the caller may read the events of none."
        }
      },
      "required": [
        "available",
        "searched",
        "retentionDays",
        "items",
        "next",
        "counts"
      ],
      "type": "object",
      "description": "One page of a search over the servers the caller may read, newest first."
    },
    "EvidenceSwitchResponse": {
      "properties": {
        "name": {
          "type": "string",
          "description": "The switch name, for example `chat_public` or `f7_reports`."
        },
        "on": {
          "type": "boolean"
        }
      },
      "required": [
        "name",
        "on"
      ],
      "type": "object",
      "description": "One evidence capture switch: its name and whether it is on."
    },
    "ExportBackupBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        }
      },
      "type": "object",
      "description": "Export a whole backup as a zip: only the optional admission choices."
    },
    "ExtendTimedChangeBody": {
      "properties": {
        "addMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many minutes later the end comes, 1 to 10080 (7 days). The total for one run is bounded by the longest period a change may run."
        },
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the server is busy or its host is offline; leave it out to refuse."
            }
          ]
        }
      },
      "type": "object",
      "description": "Extend: move a time-based end later."
    },
    "ExternalPendingResponse": {
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The name shown for the provider account, for example the Discord name."
        },
        "provider": {
          "type": "string"
        },
        "providerName": {
          "type": "string"
        },
        "returnTo": {
          "type": [
            "null",
            "string"
          ],
          "description": "The portal path to go to after signing in, or null."
        },
        "suggestedEmail": {
          "type": [
            "null",
            "string"
          ],
          "description": "An address Google reported as verified, offered as a suggestion for the email field. Never used to find an account. Null for Discord."
        }
      },
      "required": [
        "provider",
        "providerName",
        "displayName",
        "suggestedEmail",
        "returnTo"
      ],
      "type": "object",
      "description": "A Google or Discord account that signed in here but is not linked to any account yet; the person confirms an email address with a code."
    },
    "FeedbackBody": {
      "properties": {
        "appVersion": {
          "type": [
            "null",
            "string"
          ]
        },
        "browser": {
          "type": [
            "null",
            "string"
          ]
        },
        "kind": {
          "type": [
            "null",
            "string"
          ],
          "description": "`problem` or `idea`."
        },
        "message": {
          "type": [
            "null",
            "string"
          ],
          "description": "Their words, at most 2,000 characters. Keys, addresses and URL queries are removed."
        },
        "page": {
          "type": [
            "null",
            "string"
          ],
          "description": "The page they were on, as a path. Query and identifiers are removed."
        },
        "screenshot": {
          "type": [
            "null",
            "string"
          ],
          "description": "One PNG or JPEG of at most 1 MiB, base64. Optional."
        }
      },
      "type": "object",
      "description": "What a member sends as feedback. Only `kind` and `message` are needed."
    },
    "FeedbackSentResponse": {
      "properties": {
        "sent": {
          "type": "boolean"
        }
      },
      "required": [
        "sent"
      ],
      "type": "object",
      "description": "A report arrived."
    },
    "FetchOffsiteBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "chosenOverLocal": {
          "type": "boolean",
          "description": "True only when the member chose the cloud copy of a backup that is also on the host (\"Restore from the cloud copy instead\"). Left out, a backup that is on the host is refused (409 backup_on_this_computer)."
        }
      },
      "type": "object",
      "description": "Bring one cloud copy back to the server's host."
    },
    "FieldError": {
      "properties": {
        "message": {
          "type": "string",
          "description": "Safe message naming the fix, never the rejected value."
        },
        "pointer": {
          "type": "string",
          "description": "RFC 6901 pointer into the request body, for example `/targets/0`."
        },
        "reason": {
          "type": "string",
          "description": "Machine reason, for example `not_found` or `unknown_field`."
        }
      },
      "required": [
        "pointer",
        "reason",
        "message"
      ],
      "type": "object",
      "description": "One invalid field in a request."
    },
    "FileListingEntryWire": {
      "properties": {
        "bytes": {
          "format": "int64",
          "type": "integer",
          "description": "Size in bytes; 0 for a folder."
        },
        "editable": {
          "type": "boolean",
          "description": "True when the Files area can open the file in its editor."
        },
        "kind": {
          "type": "string",
          "description": "`file`, `folder` or `other` (a link, a device or another mount; never opened)."
        },
        "modified": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "Last modified, seconds since 1970; null when unknown."
        },
        "name": {
          "type": "string",
          "description": "The file or folder name (at most 255 characters, no control characters)."
        }
      },
      "required": [
        "name",
        "kind",
        "bytes",
        "editable"
      ],
      "type": "object",
      "description": "One entry of a folder in the Files area: a row of its list. Never a file's contents."
    },
    "FileListingFolderWire": {
      "properties": {
        "ageSeconds": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "How old this folder's list is in seconds, when it differs from the listing's own age. Answered only; ignored when sent."
        },
        "entries": {
          "items": {
            "$ref": "#/$defs/FileListingEntryWire"
          },
          "type": "array"
        },
        "hostLimits": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The actions the host does not offer in this folder, as the folder read names them. Answered only; ignored when sent."
        },
        "keptCopies": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many earlier copies a delete or replace keeps here, as the folder read said. Answered only; ignored when sent."
        },
        "path": {
          "type": "string",
          "description": "The folder's path below the framework's folder, as the host's tree answer names it (at most 512 characters)."
        },
        "total": {
          "format": "int32",
          "type": "integer",
          "description": "How many entries the folder holds in all; more than `entries` holds for a folder bigger than one page."
        }
      },
      "required": [
        "path",
        "total",
        "entries"
      ],
      "type": "object",
      "description": "One folder of a listing: its path below the framework's folder, how many entries it holds in all and the entries kept."
    },
    "FileListingResponse": {
      "properties": {
        "ageSeconds": {
          "format": "int64",
          "type": "integer",
          "description": "How old the listing is by the cloud's clock, so a browser with a wrong clock still says \"Updated 12 seconds ago\" truthfully."
        },
        "folders": {
          "items": {
            "$ref": "#/$defs/FileListingFolderWire"
          },
          "type": "array"
        },
        "found": {
          "type": "boolean",
          "description": "False when nothing is kept (never stored, ended after 14 days, or erased); the other members are then empty."
        },
        "framework": {
          "type": [
            "null",
            "string"
          ]
        },
        "hash": {
          "type": [
            "null",
            "string"
          ],
          "description": "Revision of this listing, in lower case hex."
        },
        "savedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the listing was kept."
        }
      },
      "required": [
        "found",
        "ageSeconds",
        "folders"
      ],
      "type": "object",
      "description": "The last listing kept for a server, or none."
    },
    "FindEntitiesRequestBody": {
      "properties": {
        "group": {
          "type": [
            "null",
            "string"
          ],
          "description": "Only this group: players, npcs, cupboards, beds, stashes, containers, loot, defences, vehicles, structures, animals, dropped, resources or other."
        },
        "max": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The most rows to return, 1 to 100. Left out, 100."
        },
        "ownerSteamId": {
          "type": [
            "null",
            "string"
          ],
          "description": "Only entities the game says this player owns: 17 digits."
        },
        "quiet": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True for a lookup a screen makes by itself: it is not listed in Activity and not announced when it ends, whatever its end. Leave out for one a person asked for."
        },
        "radius": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Metres around the centre of the area, 1 to 6000."
        },
        "text": {
          "type": [
            "null",
            "string"
          ],
          "description": "Only prefabs whose short name contains this text, ignoring case; at most 64 characters."
        },
        "x": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "East of the map's centre in whole metres, the centre of an area. With `z` and `radius`, all three or none."
        },
        "z": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "North of the map's centre in whole metres."
        }
      },
      "type": "object",
      "description": "Finds entities. Every filter given must match."
    },
    "FindPluginSourceResponse": {
      "properties": {
        "id": {
          "type": "string",
          "description": "Its stable code: `umod`, `codefling` or `chaoscode` (RustHQ)."
        },
        "installable": {
          "type": "boolean",
          "description": "True when RustSC installs plugins from it (`umod`); every other marketplace is a link to its page."
        },
        "name": {
          "type": "string"
        },
        "retrievedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the marketplace's data was read, UTC."
        },
        "sorts": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "A listing with no figure for the sort asked comes after the ranked ones."
        },
        "state": {
          "type": "string",
          "description": "`ok`, `stale` (it could not be asked, so an earlier answer is shown; `retrievedAt` says how old), `loading` (its listings are still being read for the first time; its results are missing, not empty, and asking again in a moment answers) or `unavailable` (it could not be asked and nothing earlier is held: its results are missing, not empty)."
        },
        "total": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many listings matched on this marketplace, or null when it did not say or was unavailable."
        }
      },
      "required": [
        "id",
        "name",
        "installable",
        "state",
        "total",
        "sorts",
        "retrievedAt"
      ],
      "type": "object",
      "description": "One marketplace as a search used it."
    },
    "FindPluginsResponse": {
      "properties": {
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "The one framework results are compared with: the server's only framework; null when it has none or both."
        },
        "frameworks": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The frameworks installed on the server, `oxide` and `carbon`; empty when neither is, which means nothing can be installed yet."
        },
        "more": {
          "type": "boolean",
          "description": "True when asking for the next page can find more."
        },
        "results": {
          "items": {
            "$ref": "#/$defs/FoundPluginResponse"
          },
          "type": "array",
          "description": "One page of results: up to ten listings from each marketplace, merged in the order asked for."
        },
        "sources": {
          "items": {
            "$ref": "#/$defs/FindPluginSourceResponse"
          },
          "type": "array",
          "description": "Every marketplace that was searched, in the offered order, with how it answered. A marketplace that is switched off is not listed."
        }
      },
      "required": [
        "frameworks",
        "framework",
        "sources",
        "results",
        "more"
      ],
      "type": "object",
      "description": "What a search for plugins found for one server."
    },
    "FirewallRuleChangeBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        }
      },
      "type": "object",
      "description": "Add or remove the Windows Firewall rule: only the optional admission choices. The host reads the ports itself."
    },
    "FirewallRulePortResponse": {
      "properties": {
        "port": {
          "format": "int32",
          "type": "integer"
        },
        "protocol": {
          "type": "string",
          "description": "`udp` or `tcp`."
        },
        "role": {
          "type": "string",
          "description": "`game`, `query` or `rust_plus`. Treat unknown values as other."
        }
      },
      "required": [
        "role",
        "protocol",
        "port"
      ],
      "type": "object",
      "description": "One port the rule opens."
    },
    "FirewallRuleResponse": {
      "properties": {
        "canManage": {
          "type": "boolean",
          "description": "Whether the caller may add or remove the rule (`servers.config.write`)."
        },
        "change": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResponse",
              "description": "The newest change when it is waiting, running, failed or cancelled; null when the newest change succeeded or none was ever made. A failed change names its reason in its stage."
            }
          ]
        },
        "connected": {
          "type": "boolean",
          "description": "Whether the host is connected now."
        },
        "ports": {
          "items": {
            "$ref": "#/$defs/FirewallRulePortResponse"
          },
          "type": "array",
          "description": "The ports the rule opens when `state` is `open`, as read back; empty otherwise. Compare them with the server's ports: when they differ, the rule is for earlier ports."
        },
        "profiles": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The profiles the rule applies to when `state` is `open`: `private` and `public`."
        },
        "programScoped": {
          "type": "boolean",
          "description": "True when the rule is limited to the server's game program."
        },
        "state": {
          "type": "string",
          "description": "`none`: RustSC has added no rule, or removed it. `open`: the host added the rule and read it back from Windows with exactly `ports`. Treat unknown values as other."
        },
        "supported": {
          "type": "boolean",
          "description": "False for a removed server or a host the platform does not manage."
        }
      },
      "required": [
        "state",
        "ports",
        "profiles",
        "programScoped",
        "change",
        "supported",
        "connected",
        "canManage"
      ],
      "type": "object",
      "description": "The Windows Firewall rule of a server."
    },
    "FleetPerformanceResponse": {
      "properties": {
        "groupName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The group's name, or null for the whole workspace."
        },
        "history": {
          "$ref": "#/$defs/PerformanceHistoryResponse"
        },
        "servers": {
          "items": {
            "$ref": "#/$defs/FleetServerResponse"
          },
          "type": "array",
          "description": "Each server the caller may read, in name order. A server the caller cannot see is not here and is in no figure."
        },
        "truncated": {
          "type": "boolean",
          "description": "More servers matched than the view covers (50): choose a group."
        }
      },
      "required": [
        "history",
        "groupName",
        "servers",
        "truncated"
      ],
      "type": "object",
      "description": "The combined history of the workspace's servers, or of one group, that the caller may read. `history` has the\nsame shape as one server's: only `server.players` (per bucket the sum of the servers' averages; lowest and highest are sums that\nbound the total) and `server.fps` (the mean of the servers' averages; lowest and highest are the lowest and highest on any server)."
    },
    "FleetServerResponse": {
      "properties": {
        "fps": {
          "format": "double",
          "type": [
            "null",
            "number"
          ],
          "description": "Frame rate in the newest bucket that holds a sample, or null."
        },
        "hostName": {
          "type": "string"
        },
        "lowestFps": {
          "format": "double",
          "type": [
            "null",
            "number"
          ],
          "description": "The lowest frame rate in any bucket of the range, or null."
        },
        "name": {
          "type": "string"
        },
        "observedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The start of the newest bucket that holds a sample of either: how fresh the figures are. Null when nothing was reported."
        },
        "peakPlayers": {
          "format": "double",
          "type": [
            "null",
            "number"
          ],
          "description": "The most players in any bucket of the range, or null."
        },
        "players": {
          "format": "double",
          "type": [
            "null",
            "number"
          ],
          "description": "Players in the newest bucket that holds a sample, or null when nothing was reported in the range."
        },
        "serverId": {
          "type": "string"
        }
      },
      "required": [
        "serverId",
        "name",
        "hostName",
        "players",
        "fps",
        "observedAt",
        "peakPlayers",
        "lowestFps"
      ],
      "type": "object",
      "description": "One server of a combined view with what the stored history says about it in the range."
    },
    "FolderCheckResponse": {
      "properties": {
        "allowed": {
          "type": "boolean"
        },
        "holds": {
          "type": "string",
          "description": "`nothing`, `server` or `files`."
        },
        "opens": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The parent folders RustSC will be allowed to open so the server can run there; empty for most folders."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "The first reason it cannot: `system_folder`, `home_folder`, `top_level`, `rustsc_folder`, `other_server`, `not_available`, `other_account`, `hidden_folder`, `parents_closed`, `drive_unsupported`, `not_a_folder`, `holds_server`, `not_empty`, `owned_by_other`, `name_not_allowed` or `path_too_long`; null when allowed."
        }
      },
      "required": [
        "allowed",
        "holds",
        "opens"
      ],
      "type": "object",
      "description": "Whether a server can be installed in a folder."
    },
    "FolderEntryResponse": {
      "properties": {
        "link": {
          "type": "boolean",
          "description": "True for a shortcut."
        },
        "name": {
          "type": "string"
        },
        "path": {
          "type": "string",
          "description": "Where it opens: its own path, or for a shortcut the place it leads to."
        },
        "usable": {
          "type": "boolean",
          "description": "False when the name has a character the game tools cannot take, so nothing inside could be chosen."
        }
      },
      "required": [
        "name",
        "path",
        "link",
        "usable"
      ],
      "type": "object",
      "description": "One sub-folder."
    },
    "FolderListingResponse": {
      "properties": {
        "check": {
          "$ref": "#/$defs/FolderCheckResponse",
          "description": "Whether a server can be installed in `requested`, and why not."
        },
        "exists": {
          "type": "boolean",
          "description": "False when `requested` does not exist (an install creates it)."
        },
        "folders": {
          "items": {
            "$ref": "#/$defs/FolderEntryResponse"
          },
          "type": "array",
          "description": "The sub-folders, sorted ignoring case; at most 200."
        },
        "found": {
          "items": {
            "$ref": "#/$defs/FoundServerResponse"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The Rust servers the host found in `path` and the folders directly under it, at most 8; empty when it looked and found none. Absent (null) when the\nrequest did not ask or the host's software is older than the request."
        },
        "freeBytes": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "Free bytes on the volume of `path`; null when the host cannot tell."
        },
        "more": {
          "format": "int64",
          "type": "integer",
          "description": "Folders past the listing limit: they exist but are not listed."
        },
        "moreAtLeast": {
          "type": "boolean",
          "description": "True when `more` counts only what was read; there are at least that many."
        },
        "parent": {
          "type": [
            "null",
            "string"
          ],
          "description": "The folder above `path`; null at the top."
        },
        "path": {
          "type": "string",
          "description": "The folder that was listed: the requested folder, or its nearest existing parent."
        },
        "platform": {
          "type": "string",
          "description": "The host's platform, `linux-x64` or `windows-x64`."
        },
        "requested": {
          "type": "string",
          "description": "The requested path as the host resolved it; it differs from `path` when the folder does not exist yet."
        },
        "requiredBytes": {
          "format": "int64",
          "type": "integer",
          "description": "The space an install needs."
        },
        "totalBytes": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The size of that volume; null when the host cannot tell."
        }
      },
      "required": [
        "path",
        "platform",
        "requested",
        "exists",
        "check",
        "requiredBytes",
        "folders",
        "more",
        "moreAtLeast"
      ],
      "type": "object",
      "description": "The directory names in one folder."
    },
    "ForceWipeDatesResponse": {
      "properties": {
        "days": {
          "items": {
            "$ref": "#/$defs/ForceWipeDayResponse"
          },
          "type": "array",
          "description": "The next days after now, in order."
        },
        "defaultTime": {
          "type": "string",
          "description": "The clock time (`HH:mm`) a new force wipe schedule starts at: one hour after the next moment in the asked time zone, rounded up to a quarter hour."
        },
        "refusal": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ForceWipeDayResponse",
              "description": "With a clock time: the first of the next 24 months in which that time is before the force wipe moment, so saving it is refused. Absent when none is."
            }
          ]
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "The revision of the exceptions file this cloud holds; it rises with every change the platform owner makes."
        },
        "rule": {
          "type": "string",
          "description": "The rule the moments follow: `facepunch_monthly.v1`, the first Thursday of the month at 19:00 in Europe/London unless an exception replaces a month."
        }
      },
      "required": [
        "rule",
        "revision",
        "defaultTime",
        "days"
      ],
      "type": "object",
      "description": "The next force wipe days and, when a time or offset was asked for, the wipe time of each."
    },
    "ForceWipeDayResponse": {
      "properties": {
        "fromException": {
          "type": "boolean",
          "description": "True when Facepunch announced another moment for this month (the platform owner's exceptions file); the screen says \"Updated by Facepunch\"."
        },
        "momentAt": {
          "format": "date-time",
          "type": "string",
          "description": "The force wipe moment."
        },
        "movedToForceWipe": {
          "type": "boolean",
          "description": "True when the clock time is before the moment, so the wipe would run one hour after the moment instead."
        },
        "note": {
          "type": [
            "null",
            "string"
          ],
          "description": "The owner's short plain reason for an exception."
        },
        "wipeAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the wipe runs; absent when neither a time nor an offset was asked for."
        }
      },
      "required": [
        "momentAt",
        "fromException",
        "movedToForceWipe"
      ],
      "type": "object",
      "description": "One force wipe day."
    },
    "FoundAlternateResponse": {
      "properties": {
        "affiliate": {
          "type": "boolean"
        },
        "id": {
          "type": "string",
          "description": "The marketplace's own identifier of the listing."
        },
        "link": {
          "type": "string",
          "description": "The listing's page on that marketplace."
        },
        "price": {
          "$ref": "#/$defs/PluginPriceResponse"
        },
        "rating": {
          "format": "double",
          "type": [
            "null",
            "number"
          ]
        },
        "ratingCount": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ]
        },
        "source": {
          "type": "string",
          "description": "The marketplace's code."
        },
        "sourceName": {
          "type": "string",
          "description": "The marketplace's name as shown to members."
        }
      },
      "required": [
        "source",
        "sourceName",
        "id",
        "price",
        "link",
        "affiliate",
        "rating",
        "ratingCount"
      ],
      "type": "object"
    },
    "FoundPluginDetailResponse": {
      "properties": {
        "description": {
          "type": [
            "null",
            "string"
          ],
          "description": "The fuller description in plain text, at most characters; null when the marketplace publishes only the short one."
        },
        "license": {
          "type": [
            "null",
            "string"
          ]
        },
        "plugin": {
          "$ref": "#/$defs/FoundPluginResponse"
        },
        "releaseNote": {
          "type": [
            "null",
            "string"
          ],
          "description": "The latest release's notes in plain text; null when the marketplace publishes none."
        },
        "requires": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Plugins the marketplace says this one needs (uMod); empty when it states none."
        },
        "retrievedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "state": {
          "type": "string",
          "description": "`ok` or `stale` (an earlier answer, see `retrievedAt`)."
        },
        "suggests": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Plugins the marketplace says work well with it."
        }
      },
      "required": [
        "plugin",
        "description",
        "releaseNote",
        "requires",
        "suggests",
        "license",
        "state",
        "retrievedAt"
      ],
      "type": "object",
      "description": "One listing's detail (`GET .../servers/{serverId}/plugins/find/{source}/{id}`)."
    },
    "FoundPluginInstalledResponse": {
      "properties": {
        "pluginId": {
          "type": "string",
          "description": "The server's plugin (`plg_`), for the plugin's own page."
        },
        "state": {
          "type": "string",
          "description": "`installed`, or `update_available` when the marketplace the member follows for that plugin lists a newer version."
        },
        "version": {
          "type": [
            "null",
            "string"
          ],
          "description": "The installed version as the plugin's own header writes it; null when it could not be read."
        }
      },
      "required": [
        "state",
        "version",
        "pluginId"
      ],
      "type": "object",
      "description": "Whether a found plugin is on the server."
    },
    "FoundPluginResponse": {
      "properties": {
        "affiliate": {
          "type": "boolean",
          "description": "True when buying through `link` earns RustSC a commission; the portal says so next to the link, in plain words."
        },
        "alternates": {
          "items": {
            "$ref": "#/$defs/FoundAlternateResponse"
          },
          "type": "array",
          "description": "The same plugin on other marketplaces (same name and same author, both stated), in preference order; empty when there is none. The result itself is the preferred offer."
        },
        "author": {
          "type": [
            "null",
            "string"
          ]
        },
        "compatibility": {
          "type": "string",
          "description": "`listed` (the marketplace lists it for the server's framework), `likely` (an Oxide plugin on a Carbon server, which runs most Oxide plugins), `other` (listed for another framework only) or `unknown` (the marketplace states none, or the server has none or both)."
        },
        "downloads": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ]
        },
        "frameworks": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The frameworks the marketplace itself lists the plugin for (`oxide`, `carbon`); empty when it says nothing."
        },
        "id": {
          "type": "string",
          "description": "The marketplace's own identifier of the listing, used to open its detail."
        },
        "image": {
          "type": [
            "null",
            "string"
          ],
          "description": "RustSC's own address of the plugin's logo or thumbnail (a copy RustSC keeps, so the member's browser never contacts the marketplace); null when the marketplace shows none or its pictures are not shown."
        },
        "installSource": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name to pass as `source` to `installServerPlugin` with `marketplace` set to this listing's `source`; null when RustSC does not install from this marketplace or the listing has no release. For Codefling it is the listing id, set only when the workspace's own Codefling account owns the listing and Codefling lists it as a single `.cs` file."
        },
        "installed": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/FoundPluginInstalledResponse",
              "description": "Set when the plugin file is already on the server."
            }
          ]
        },
        "link": {
          "type": "string",
          "description": "The listing's page on the marketplace, with RustSC's affiliate form when `affiliate` is true."
        },
        "lowestPrice": {
          "type": "boolean"
        },
        "name": {
          "type": "string"
        },
        "owned": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Codefling only, when the workspace connected its own Codefling account: true when that account owns the listing (Codefling's own `canDownload`), false when it does not. Null for every other marketplace, when no account is connected, or when Codefling did not answer."
        },
        "price": {
          "$ref": "#/$defs/PluginPriceResponse"
        },
        "rating": {
          "format": "double",
          "type": [
            "null",
            "number"
          ],
          "description": "Average out of 5; null when the marketplace has no reviews of it or does not publish them in its listing."
        },
        "ratingCount": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many reviews the rating rests on; null when the marketplace does not state it."
        },
        "source": {
          "type": "string",
          "description": "The marketplace's code."
        },
        "sourceName": {
          "type": "string",
          "description": "The marketplace's name as shown to members."
        },
        "subscription": {
          "type": "boolean"
        },
        "summary": {
          "type": "string",
          "description": "The marketplace's short description in plain text, at most characters: its own short field where it has one, otherwise the start of its description. Always shown with the marketplace's name."
        },
        "tags": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "unmaintained": {
          "type": "boolean",
          "description": "True when the marketplace itself tags the plugin as unmaintained."
        },
        "updatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the latest release was published, UTC."
        },
        "version": {
          "type": [
            "null",
            "string"
          ],
          "description": "The latest version, exactly as the marketplace writes it."
        }
      },
      "required": [
        "source",
        "sourceName",
        "id",
        "name",
        "author",
        "version",
        "summary",
        "price",
        "subscription",
        "link",
        "affiliate",
        "downloads",
        "image",
        "ratingCount",
        "alternates",
        "lowestPrice",
        "rating",
        "updatedAt",
        "tags",
        "frameworks",
        "compatibility",
        "unmaintained",
        "installSource",
        "installed"
      ],
      "type": "object",
      "description": "One listing as its marketplace published it. Every text is plain text: no markup, no link, a length cap. The listing always names its\nmarketplace; a field the marketplace does not publish is null."
    },
    "FoundServerResponse": {
      "properties": {
        "identities": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The names of the server's settings folders (identities), at most 5; empty when it has none yet."
        },
        "name": {
          "type": "string",
          "description": "The folder's name."
        },
        "path": {
          "type": "string",
          "description": "The folder's path on the host."
        }
      },
      "required": [
        "name",
        "path",
        "identities"
      ],
      "type": "object",
      "description": "A folder that holds a Rust server, found by looking at folder and entry names only."
    },
    "FrameworkVersionResponse": {
      "properties": {
        "name": {
          "type": "string",
          "description": "`none`, `oxide`, `carbon` or `both`, from the framework's own files only (data folders alone are none)."
        },
        "observedAt": {
          "format": "date-time",
          "type": "string"
        },
        "state": {
          "type": [
            "null",
            "string"
          ],
          "description": "`needs_reinstall` after a game update replaced the files it patched (Reinstall framework clears it), `change_failed` after a framework change that failed while it changed files. Null otherwise."
        }
      },
      "required": [
        "name",
        "state",
        "observedAt"
      ],
      "type": "object",
      "description": "The framework a server's files point to."
    },
    "FreezePlayerRequestBody": {
      "properties": {
        "minutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How long the freeze lasts, in whole minutes: 1 to 60, 10 when left out."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the player, only so the activity line says it; optional, up to 64 characters."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "The reason the player is told, up to 120 characters; optional."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID of the player, 17 digits. A name never selects a player."
        }
      },
      "required": [
        "steamId"
      ],
      "type": "object",
      "description": "Holds a connected player in place for a while."
    },
    "GameBranchResponse": {
      "properties": {
        "buildId": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The branch's current Steam build number, when Steam gave one."
        },
        "name": {
          "type": "string",
          "description": "The value to send as `branch` when adding a server, for example `staging`."
        },
        "passwordRequired": {
          "type": "boolean",
          "description": "True when Steam protects the branch with a password. RustSC holds no branch passwords, so it cannot install one."
        },
        "updatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When Steam says the branch last changed."
        }
      },
      "required": [
        "name",
        "passwordRequired"
      ],
      "type": "object"
    },
    "GameBranchesResponse": {
      "properties": {
        "branches": {
          "items": {
            "$ref": "#/$defs/GameBranchResponse"
          },
          "type": "array",
          "description": "Every branch Steam lists, `public` first and then by name. Empty until the platform has read Steam once."
        },
        "retrievedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the platform last read Steam successfully; absent when it never has."
        }
      },
      "required": [
        "branches"
      ],
      "type": "object",
      "description": "The Steam branches of the Rust dedicated server the platform last read."
    },
    "GameBuildCheckResponse": {
      "properties": {
        "game": {
          "$ref": "#/$defs/ComponentVersionResponse",
          "description": "The game component as the versions read shows it now (a requested read has not finished yet)."
        },
        "outcome": {
          "type": "string",
          "description": "`fresh`, `requested`, `pending`, `waiting` or `unavailable`. Treat unknown values as `unavailable`."
        }
      },
      "required": [
        "outcome",
        "game"
      ],
      "type": "object",
      "description": "What Check for updates did and the game version after it."
    },
    "GameExitListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/GameExitResponse"
          },
          "type": "array",
          "description": "Newest first; at most the requested limit (default 20, most 50)."
        }
      },
      "required": [
        "items"
      ],
      "type": "object"
    },
    "GameExitReadyResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "entityCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "framerate": {
          "format": "double",
          "type": [
            "null",
            "number"
          ]
        },
        "phase": {
          "type": [
            "null",
            "string"
          ],
          "description": "The last phase the game's log showed before the answer."
        },
        "players": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "probes": {
          "format": "int32",
          "type": "integer"
        },
        "secondsAfterStart": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "Seconds from the process start to the confirmation; a small number means the game answered while it was still loading."
        },
        "uptimeSeconds": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ]
        }
      },
      "required": [
        "probes"
      ],
      "type": "object",
      "description": "What the host saw when it called the game ready."
    },
    "GameExitResponse": {
      "properties": {
        "decision": {
          "type": "string",
          "description": "What crash recovery decided: relaunched, waiting, held, nothing_to_recover and so on."
        },
        "decisionReason": {
          "type": [
            "null",
            "string"
          ]
        },
        "endReason": {
          "type": [
            "null",
            "string"
          ]
        },
        "endedAt": {
          "format": "date-time",
          "type": "string"
        },
        "executable": {
          "type": [
            "null",
            "string"
          ]
        },
        "exitCode": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The exit code the host read; absent when the game ended by a signal or no code could be read. A Windows code can be negative."
        },
        "frameworkLog": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The last lines of the newest Carbon or Oxide log file, redacted."
        },
        "frameworkLogFile": {
          "type": [
            "null",
            "string"
          ]
        },
        "gameLog": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The last lines of the game's own log, redacted."
        },
        "gameLogFile": {
          "type": [
            "null",
            "string"
          ]
        },
        "id": {
          "type": "string"
        },
        "launchId": {
          "type": "string",
          "description": "The host's own name for this run of the game."
        },
        "origin": {
          "type": "string",
          "description": "launch: the host started the game. rediscovery: it found the game already running."
        },
        "processId": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "ready": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/GameExitReadyResponse"
            }
          ]
        },
        "signal": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The signal that ended the game; absent when it exited by itself."
        },
        "startedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "stopIntended": {
          "type": "boolean",
          "description": "True when a stop was recorded before the end (a Stop, Restart, update or wipe), so the end was no crash."
        },
        "stopReason": {
          "type": [
            "null",
            "string"
          ]
        },
        "uptimeSeconds": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "Whole seconds from start to end; absent when the start is not known."
        }
      },
      "required": [
        "id",
        "launchId",
        "endedAt",
        "stopIntended",
        "decision",
        "origin",
        "gameLog",
        "frameworkLog"
      ],
      "type": "object",
      "description": "The end of one game process as its host reported it, with the redacted tails of the game's and the framework's log."
    },
    "GiveItemSetRequestBody": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the player, only to word the operation's summary; optional."
        },
        "revision": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The set's revision the member looked at. When the set has changed since, nothing is given (412 `revision_conflict`). Left out, the set as it is now is given."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID of the connected player, 17 digits."
        }
      },
      "required": [
        "steamId"
      ],
      "type": "object",
      "description": "Gives a saved item set to one connected player."
    },
    "GivePlayerItemsRequestBody": {
      "properties": {
        "amount": {
          "format": "int32",
          "type": "integer",
          "description": "How many, 1 to 100000. What does not fit in the player's inventory is not given and not dropped."
        },
        "item": {
          "type": "string"
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the player, only so the activity line says it; optional."
        },
        "skin": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "A skin number; left out or 0 gives the item without a skin."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID of the player, 17 digits."
        }
      },
      "required": [
        "steamId",
        "item",
        "amount"
      ],
      "type": "object",
      "description": "Gives one connected player an item."
    },
    "GiveTemporaryAccessBody": {
      "properties": {
        "allServers": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True for every server that offers it now and where you may give it. A server added later is not included."
        },
        "endsAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When it ends. Give this or length."
        },
        "groups": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The groups to give, such as vip."
        },
        "length": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/TemporaryLengthBody",
              "description": "How long, from now (or added to the time left when the player already has it). Give this or endsAt."
            }
          ]
        },
        "note": {
          "type": [
            "null",
            "string"
          ],
          "description": "A note for your team, at most 200 characters."
        },
        "pack": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name of a saved pack to give instead of groups, permissions and length. Its usual length is used unless you send a length or endsAt. Do not send groups or permissions with it."
        },
        "permissions": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Single permissions to give, such as plugin.use."
        },
        "playerName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The player's name as you know it, kept for the list (at most 32 characters)."
        },
        "preview": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True to see what would happen without giving anything."
        },
        "reference": {
          "type": [
            "null",
            "string"
          ],
          "description": "An order number or note from your store, at most 100 characters. A reference is used once: giving again with it changes nothing."
        },
        "serverIds": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The servers (`srv_...`). Leave it out with allServers."
        },
        "steamId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The player's 17 digit Steam ID. Required."
        }
      },
      "type": "object",
      "description": "Give a player one or more groups and permissions for a set time (`POST .../temporary-access`)."
    },
    "GiveTemporaryAccessResponse": {
      "properties": {
        "endNotice": {
          "type": "boolean",
          "description": "True when the workspace switched the end notice on: the player is told on Discord a day before the end and at the end, if they linked their Discord account."
        },
        "entries": {
          "items": {
            "$ref": "#/$defs/TemporaryAccessGivenResponse"
          },
          "type": "array"
        },
        "playerName": {
          "type": [
            "null",
            "string"
          ]
        },
        "preview": {
          "type": "boolean",
          "description": "True when this was a preview and nothing was given."
        },
        "steamId": {
          "type": "string"
        }
      },
      "required": [
        "preview",
        "steamId",
        "entries",
        "endNotice"
      ],
      "type": "object",
      "description": "What a give did."
    },
    "GlobalBanListCheckResponse": {
      "properties": {
        "asked": {
          "format": "int32",
          "type": "integer",
          "description": "How many connected hosts were asked which list they hold. Their answers update the state in a moment."
        }
      },
      "required": [
        "asked"
      ],
      "type": "object",
      "description": "What Check again did (`POST .../global-ban-list/check`)."
    },
    "GlobalBanListResponse": {
      "properties": {
        "behindCount": {
          "format": "int32",
          "type": "integer",
          "description": "How many servers are `behind`."
        },
        "count": {
          "format": "int32",
          "type": "integer",
          "description": "How many bans the list holds."
        },
        "servers": {
          "items": {
            "$ref": "#/$defs/GlobalBanServerResponse"
          },
          "type": "array"
        },
        "version": {
          "format": "int64",
          "type": "integer",
          "description": "The cloud's version of the list; 0 when the workspace never had a global ban. It grows by one for every change."
        }
      },
      "required": [
        "version",
        "count",
        "behindCount",
        "servers"
      ],
      "type": "object",
      "description": "The state of the workspace's global ban list on every server (`GET .../global-ban-list`)."
    },
    "GlobalBanServerResponse": {
      "properties": {
        "door": {
          "type": [
            "null",
            "string"
          ],
          "description": "How the list reaches the server, as its host last said: `door` (the game asks the host on every join and refuses a listed player before they are in), `after_joining` (the host\nremoves a listed player a few seconds after they join) or `off` (nothing is set on the game: it is not running, or the list is empty). Null until the host has said."
        },
        "id": {
          "type": "string",
          "description": "The server (`srv_...`)."
        },
        "name": {
          "type": "string"
        },
        "state": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "state"
      ],
      "type": "object",
      "description": "One server's place in the global ban list."
    },
    "GoBackPluginLibraryBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "fileName": {
          "type": [
            "null",
            "string"
          ]
        },
        "framework": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object"
    },
    "HealPlayerRequestBody": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the player, only so the activity line says it; optional, up to 64 characters."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID of the player, 17 digits. A name never selects a player."
        }
      },
      "required": [
        "steamId"
      ],
      "type": "object",
      "description": "Heals one connected player."
    },
    "HelperBody": {
      "properties": {
        "arguments": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The arguments, one value each (never a command line); up to 64."
        },
        "delaySeconds": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Seconds to wait after the trigger, 0 to 3600."
        },
        "enabled": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Whether it runs; absent is on."
        },
        "folder": {
          "type": [
            "null",
            "string"
          ],
          "description": "The folder to run it in; empty or absent is the folder the program is in."
        },
        "id": {
          "type": [
            "null",
            "string"
          ],
          "description": "A name for the helper: 1 to 64 letters, digits, hyphens or underscores, unique in the list."
        },
        "program": {
          "type": [
            "null",
            "string"
          ],
          "description": "The full path of the program on the server's host. A .bat or .cmd file cannot be run."
        },
        "trigger": {
          "type": [
            "null",
            "string"
          ],
          "description": "`startup` (with the game) or `readiness` (once the game is ready)."
        }
      },
      "type": "object",
      "description": "One helper: a program the host starts around the server's start."
    },
    "HelpersBody": {
      "properties": {
        "helpers": {
          "items": {
            "$ref": "#/$defs/HelperBody"
          },
          "type": [
            "null",
            "array"
          ]
        }
      },
      "type": "object",
      "description": "A server's whole portal-defined list of helpers."
    },
    "HelpersResponse": {
      "properties": {
        "delivery": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResponse",
              "description": "The newest operation as it is now; its error reason says why the host refused a list, and its result names the helper. Null before the first save."
            }
          ]
        },
        "helpers": {
          "items": {
            "$ref": "#/$defs/HelperBody"
          },
          "type": "array",
          "description": "The list the host applied last (empty before the first save)."
        },
        "requested": {
          "items": {
            "$ref": "#/$defs/HelperBody"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The list of the newest save when the host has not applied it (still delivering, or refused), so it can be corrected; null otherwise."
        }
      },
      "required": [
        "helpers",
        "requested",
        "delivery"
      ],
      "type": "object",
      "description": "A server's portal-defined helpers."
    },
    "HostAccessBody": {
      "properties": {
        "hostId": {
          "type": "string",
          "description": "Host ID. A host of another workspace, a removed one and one that never existed are all `not_found`."
        }
      },
      "required": [
        "hostId"
      ],
      "type": "object",
      "description": "One host a member may see."
    },
    "HostAlertSettingsResponse": {
      "properties": {
        "cpu": {
          "$ref": "#/$defs/AlertRuleSettingBody"
        },
        "diskEnabled": {
          "type": "boolean"
        },
        "diskQueue": {
          "$ref": "#/$defs/AlertRuleSettingBody"
        },
        "memory": {
          "$ref": "#/$defs/AlertRuleSettingBody"
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "revision",
        "diskEnabled",
        "cpu",
        "memory",
        "diskQueue"
      ],
      "type": "object"
    },
    "HostAlertsResponse": {
      "properties": {
        "alerts": {
          "items": {
            "$ref": "#/$defs/ResourceAlertResponse"
          },
          "type": "array"
        },
        "hostId": {
          "type": "string"
        },
        "hostName": {
          "type": "string"
        },
        "settings": {
          "$ref": "#/$defs/HostAlertSettingsResponse"
        },
        "supported": {
          "type": "boolean",
          "description": "False for a host whose system does not measure resources yet (Windows)."
        }
      },
      "required": [
        "hostId",
        "hostName",
        "supported",
        "settings",
        "alerts"
      ],
      "type": "object"
    },
    "HostFactsResponse": {
      "properties": {
        "cpuCount": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The logical processors the host software can use."
        },
        "hostSoftwareVersion": {
          "type": [
            "null",
            "string"
          ],
          "description": "The version of the RustSC host software, for example `1.4.2`."
        },
        "kernelVersion": {
          "type": [
            "null",
            "string"
          ],
          "description": "The kernel release, for example `6.8.0-138-generic`."
        },
        "memoryBytes": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The host's memory in bytes as the operating system reports it (Linux: MemTotal, the usable RAM)."
        },
        "observedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the host read these facts, UTC."
        },
        "systemName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The operating system's own name and version, for example `Ubuntu 24.04.3 LTS`; the host's own text."
        },
        "timeZone": {
          "type": [
            "null",
            "string"
          ],
          "description": "The host's time zone as an IANA id, for example `Europe/Berlin`; null when the host did not say (an older RustSC, or a zone it could not\nread). Its servers' schedules use it unless a zone was chosen for a server."
        }
      },
      "required": [
        "systemName",
        "kernelVersion",
        "cpuCount",
        "memoryBytes",
        "hostSoftwareVersion",
        "observedAt"
      ],
      "type": "object",
      "description": "The facts a host reported about itself once at start and again when they change. Each is null when the host\ndid not report it or could not read it; show nothing for a null fact."
    },
    "HostListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/HostResponse"
          },
          "type": "array",
          "description": "Hosts ordered by name, then ID."
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "The cursor of the next page, or null on the last page."
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Hosts on all pages."
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount"
      ],
      "type": "object",
      "description": "The workspace's hosts by name, one page at a time."
    },
    "HostLogLineListResponse": {
      "properties": {
        "hasMore": {
          "type": "boolean",
          "description": "True when older lines match; read again with before set to the time of the last line."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/HostLogLineResponse"
          },
          "type": "array",
          "description": "Newest first."
        }
      },
      "required": [
        "items",
        "hasMore"
      ],
      "type": "object"
    },
    "HostLogLineResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": "string",
          "description": "When the host wrote the line."
        },
        "event": {
          "type": "string",
          "description": "The stable event name, for example Cloud.Connected."
        },
        "id": {
          "type": "string"
        },
        "level": {
          "type": "string",
          "description": "information, warning, error or critical."
        },
        "serverId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The server the line is about; absent for the host itself."
        },
        "source": {
          "type": "string",
          "description": "Which RustSC program on the host wrote the line."
        },
        "text": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "at",
        "level",
        "event",
        "text"
      ],
      "type": "object",
      "description": "One line of the host's own log, already redacted by the host."
    },
    "HostMeasurementsResponse": {
      "properties": {
        "available": {
          "type": "boolean"
        },
        "cpu": {
          "$ref": "#/$defs/CurrentMeasurementResponse"
        },
        "hostId": {
          "type": "string"
        },
        "hostSoftwareVersion": {
          "type": [
            "null",
            "string"
          ]
        },
        "memory": {
          "$ref": "#/$defs/HostMemoryResponse"
        },
        "name": {
          "type": "string"
        },
        "observedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "supported": {
          "type": "boolean"
        },
        "volumeCoverage": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/HostVolumeCoverage"
            }
          ]
        },
        "volumes": {
          "items": {
            "$ref": "#/$defs/HostVolumeResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "hostId",
        "name",
        "hostSoftwareVersion",
        "supported",
        "available",
        "observedAt",
        "cpu",
        "memory",
        "volumes",
        "volumeCoverage"
      ],
      "type": "object"
    },
    "HostMemoryResponse": {
      "properties": {
        "availableBytes": {
          "$ref": "#/$defs/CurrentMeasurementResponse"
        },
        "totalBytes": {
          "$ref": "#/$defs/CurrentMeasurementResponse"
        },
        "usedBytes": {
          "$ref": "#/$defs/CurrentMeasurementResponse"
        }
      },
      "required": [
        "usedBytes",
        "totalBytes",
        "availableBytes"
      ],
      "type": "object"
    },
    "HostOsUpdatesResponse": {
      "properties": {
        "changedOnComputer": {
          "type": "boolean",
          "description": "True while a change made on the host with `rustsc host os-updates set` is in force. A new save from the portal or the API replaces it."
        },
        "changedOnComputerAt": {
          "type": [
            "null",
            "string"
          ],
          "description": "When that change was made; null when it is not in force or the host did not record the time."
        },
        "choice": {
          "$ref": "#/$defs/OsUpdatesChoiceResponse",
          "description": "The choice in force. While bool HostOsUpdatesResponse.ChangedOnComputer is true it is the choice a person set on the host itself (on top of the saved one), as the host reported it;\notherwise it is the saved choice."
        },
        "hostId": {
          "type": "string"
        },
        "hostName": {
          "type": "string"
        },
        "hostReported": {
          "type": "boolean",
          "description": "True once the host has reported on updates, so its RustSC knows this section; false means it needs updating first."
        },
        "included": {
          "type": "boolean"
        },
        "restartByScheduleSupported": {
          "type": "boolean",
          "description": "True when the host can install updates as part of a \"Restart host\" schedule (its RustSC is new enough)."
        },
        "restartHostUpdatesOpen": {
          "type": "boolean",
          "description": "True when installing updates with a \"Restart host\" schedule is available here (false in the beta: the separate updates choice is used)."
        },
        "restartScheduleId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The \"Restart host\" schedule (a host restart schedule ID) these updates belong to; null when the choice stands on its own (saved with this route)."
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "run": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OsUpdatesRunResponse"
            }
          ]
        },
        "saved": {
          "type": "boolean",
          "description": "False until the form is saved once; the choice is then the standard and nothing is active."
        },
        "supported": {
          "type": "boolean",
          "description": "True for a Windows host with an enrolled install. Elsewhere the section says so and offers nothing."
        }
      },
      "required": [
        "hostId",
        "hostName",
        "supported",
        "hostReported",
        "saved",
        "revision",
        "choice",
        "changedOnComputer",
        "included"
      ],
      "type": "object"
    },
    "HostPerformanceResponse": {
      "properties": {
        "history": {
          "$ref": "#/$defs/PerformanceHistoryResponse",
          "description": "The host's own series; `markers` is empty."
        },
        "hostName": {
          "type": "string",
          "description": "The host's display name."
        },
        "latest": {
          "$ref": "#/$defs/HostMeasurementsResponse",
          "description": "The latest current observations and reported volume snapshot."
        },
        "servers": {
          "items": {
            "$ref": "#/$defs/HostServerPerformanceResponse"
          },
          "type": "array",
          "description": "The servers on the host the caller may read, by name; at most 6."
        },
        "truncated": {
          "type": "boolean",
          "description": "More servers than the page draws (6): the rest are on the host's Servers tab."
        }
      },
      "required": [
        "latest",
        "history",
        "hostName",
        "servers",
        "truncated"
      ],
      "type": "object",
      "description": "A host's history: `history` is the whole host as the operating system measures it, and `servers`\neach readable server's own game process and players. The two are separate and not meant to add up: the host's figures include the\nsystem and every other program."
    },
    "HostPermissionsResponse": {
      "properties": {
        "hostId": {
          "type": "string",
          "description": "Host ID, for example `host_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "permissions": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Permission names held on this host, from the permission catalog."
        }
      },
      "required": [
        "hostId",
        "permissions"
      ],
      "type": "object",
      "description": "The permissions the caller holds on one host."
    },
    "HostRemovalResponse": {
      "properties": {
        "endedOperations": {
          "format": "int32",
          "type": "integer",
          "description": "Unfinished operations the removal ended."
        },
        "endedSchedules": {
          "format": "int32",
          "type": "integer",
          "description": "Schedules the removal ended (the host's restart schedules and the removed servers' schedules)."
        },
        "id": {
          "type": "string",
          "description": "Host ID, for example `host_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "keptServerIds": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The servers this removal kept listed as Host removed."
        },
        "name": {
          "type": "string",
          "description": "The host's name, kept for history."
        },
        "operationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The uninstall operation ID, when uninstall was requested."
        },
        "removedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "removedServerIds": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The servers this removal removed from RustSC."
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "servers": {
          "type": "string",
          "description": "`remove` or `keep`, as chosen."
        },
        "state": {
          "type": "string",
          "description": "`removed`, or `uninstalling` while the host runs its uninstall first (follow `operationId`)."
        },
        "uninstall": {
          "type": "string",
          "description": "`not_asked`, `waiting`, `started`, `refused` or `not_confirmed`."
        },
        "uninstallReason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why the uninstall was refused or not confirmed, for example `uninstall_unavailable` or `no_answer`; otherwise null."
        }
      },
      "required": [
        "id",
        "name",
        "state",
        "servers",
        "uninstall",
        "removedServerIds",
        "keptServerIds",
        "endedOperations",
        "endedSchedules",
        "revision"
      ],
      "type": "object",
      "description": "A host as its removal left it."
    },
    "HostResponse": {
      "properties": {
        "createdAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the host record was created, UTC."
        },
        "currentInstallation": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/InstallationResponse",
              "description": "The installation that manages this host now, or null."
            }
          ]
        },
        "facts": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/HostFactsResponse",
              "description": "What the host reported about itself and its software; null before the first report (an older host never reports)."
            }
          ]
        },
        "id": {
          "type": "string",
          "description": "Host ID, for example `host_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "kind": {
          "type": "string",
          "description": "`full` (RustSC host service) or `restricted` (provider panel). Treat unknown values as other."
        },
        "logErrorAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the newest Error or Critical line of the host's own log was written; absent when none was sent. Only a host whose member switched on \"Send this host's log to the portal\" sends any. The host row says \"Host reports errors\" while this is under an hour old."
        },
        "name": {
          "type": "string",
          "description": "Display name. Starts as the name the host reported at enrollment; a label only."
        },
        "operatingSystem": {
          "type": [
            "null",
            "string"
          ],
          "description": "The operating system the host reported, for example `linux`; null when not reported."
        },
        "replacementCandidate": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/InstallationResponse",
              "description": "A newly enrolled installation waiting for a member to confirm it as the replacement, or null."
            }
          ]
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "The host revision. A replacement confirmation sends it in `If-Match`."
        }
      },
      "required": [
        "id",
        "name",
        "kind",
        "operatingSystem",
        "revision",
        "createdAt",
        "facts",
        "currentInstallation",
        "replacementCandidate"
      ],
      "type": "object",
      "description": "A host: one machine running the RustSC host service, or a provider account."
    },
    "HostRestartScheduleListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/HostRestartScheduleResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "The cursor of the next page; null on the last page."
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Always null."
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount"
      ],
      "type": "object",
      "description": "One page of host restart schedules, oldest first."
    },
    "HostRestartScheduleRequestBody": {
      "properties": {
        "enabled": {
          "type": [
            "null",
            "boolean"
          ]
        },
        "installUpdates": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/InstallUpdatesBody",
              "description": "Install Windows updates before each restart. Absent: on a new schedule, no updates; on a change, the schedule keeps what it had\n(its updates follow the new restart time). `{\"enabled\": false}` stops them. The install starts `leadMinutes` before the restart time, on the same days (the day before when\nthat crosses midnight); there is no separate install time. Only on a Windows host, with a restart that repeats daily or weekly, and on one schedule per host."
            }
          ]
        },
        "onlyWhileRebootPending": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True runs an occurrence only while the host reports that its operating system needs a restart; otherwise the occurrence is skipped with `condition_not_met`. Absent means false: always restart."
        },
        "pauseServerRestarts": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True: on a day this schedule restarts the host (it ran, or will run because it always restarts or the host needs a restart now), the host skips the\nscheduled restarts of the servers on it with `computer_restarts_today`, so no server restarts twice. The day is the schedule's own calendar day in its\ntime zone. Absent means false (the whole revision is sent on every save). See the host restart schedules design note."
        },
        "timing": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ScheduleTimingBody"
            }
          ]
        }
      },
      "type": "object",
      "description": "One revision of a host's restart schedule as an Owner saves it. The whole revision is sent on every save; the host is\nthe one in the path. The timing is the same calendar intent every schedule uses; its `leadMinutes` is the warning players get."
    },
    "HostRestartScheduleResponse": {
      "properties": {
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "disabledReason": {
          "type": [
            "null",
            "string"
          ]
        },
        "hostDelivery": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ScheduleDeliveryResponse",
              "description": "Whether the host holds the current revision. `pending` until it acknowledged storing it: until then an edit or removal is not in effect\non the host, which keeps running the revision it has (a host that is offline or too old to run host schedules keeps the schedule waiting). Null for a schedule the cloud ran before schedules moved onto the host, until the host takes it over at its next restart time."
            }
          ]
        },
        "hostId": {
          "type": "string"
        },
        "id": {
          "type": "string",
          "description": "Schedule ID, for example `sch_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "installUpdates": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/InstallUpdatesResponse",
              "description": "The Windows updates this schedule installs before its restart; null when it installs none."
            }
          ]
        },
        "nextOccurrence": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/NextOccurrenceResponse",
              "description": "The next occurrence the host will decide, calculated with the rules the host uses; null when nothing is pending. The host runs the schedule itself, so it keeps running while the cloud is unreachable."
            }
          ]
        },
        "onlyWhileRebootPending": {
          "type": "boolean"
        },
        "pauseServerRestarts": {
          "type": "boolean",
          "description": "Whether scheduled server restarts are skipped on the days this schedule restarts the host (`computer_restarts_today`)."
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "The current revision; also the ETag (`\"r&lt;revision&gt;\"`)."
        },
        "state": {
          "type": "string",
          "description": "`active`, `disabled` or `revoked`. Treat unknown values as other."
        },
        "timing": {
          "$ref": "#/$defs/ScheduleTimingResponse"
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        },
        "updatedBy": {
          "$ref": "#/$defs/ScheduleActorResponse",
          "description": "The member who saved the current revision."
        }
      },
      "required": [
        "id",
        "hostId",
        "revision",
        "state",
        "timing",
        "onlyWhileRebootPending",
        "pauseServerRestarts",
        "disabledReason",
        "nextOccurrence",
        "hostDelivery",
        "updatedBy",
        "createdAt",
        "updatedAt"
      ],
      "type": "object",
      "description": "A host restart schedule with its current revision and next occurrence."
    },
    "HostRestartSettingResponse": {
      "properties": {
        "hostId": {
          "type": "string"
        },
        "plannedRestartAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The scheduled server restart this host is planned to restart with, as the host last reported it; absent when none is planned or the choice is off."
        },
        "restartWithServerRestart": {
          "type": "boolean"
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "saved": {
          "type": "boolean",
          "description": "False until a member saved the choice once; until then restartWithServerRestart is false (the box is not ticked) and nothing is active."
        }
      },
      "required": [
        "hostId",
        "saved",
        "restartWithServerRestart",
        "revision"
      ],
      "type": "object"
    },
    "HostServerPerformanceResponse": {
      "properties": {
        "name": {
          "type": "string"
        },
        "series": {
          "items": {
            "$ref": "#/$defs/PerformanceSeriesResponse"
          },
          "type": "array",
          "description": "`server.cpu_percent`, `server.memory_bytes` and `server.players`, in that order."
        },
        "serverId": {
          "type": "string"
        }
      },
      "required": [
        "serverId",
        "name",
        "series"
      ],
      "type": "object",
      "description": "One server on a host with its own processor use, memory and players over the same range and buckets as the host's series."
    },
    "HostStepListResponse": {
      "properties": {
        "hasMore": {
          "type": "boolean",
          "description": "True when older steps remain; read again with before set to the end time of the last step."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/HostStepResponse"
          },
          "type": "array",
          "description": "Newest first."
        }
      },
      "required": [
        "items",
        "hasMore"
      ],
      "type": "object"
    },
    "HostStepResponse": {
      "properties": {
        "area": {
          "type": "string",
          "description": "install, update, framework, self_update, backup, restore, wipe, recovery, os_updates, runner, app or console, or another area name."
        },
        "counts": {
          "additionalProperties": {
            "format": "int64",
            "type": "integer"
          },
          "type": "object",
          "description": "At most 12 named whole numbers (files copied, retries)."
        },
        "endedAt": {
          "format": "date-time",
          "type": "string"
        },
        "errorCode": {
          "type": [
            "null",
            "string"
          ],
          "description": "The code of the failure the step met, for support."
        },
        "id": {
          "type": "string"
        },
        "outcome": {
          "type": "string",
          "description": "ok, failed or skipped."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "A short reason code when the step failed or was skipped."
        },
        "serverId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The server the step is about; absent for the host itself."
        },
        "startedAt": {
          "format": "date-time",
          "type": "string"
        },
        "step": {
          "type": "string",
          "description": "The host's own short name for the step; for support, not for sentences."
        },
        "tail": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The end of the step's output, oldest first, at most 40 lines, redacted by the host."
        }
      },
      "required": [
        "id",
        "area",
        "step",
        "outcome",
        "startedAt",
        "endedAt",
        "counts",
        "tail"
      ],
      "type": "object",
      "description": "One step of a host's own work, as the host reported it: what it did and how it ended."
    },
    "HostVolumeCoverage": {
      "properties": {
        "returned": {
          "format": "int32",
          "type": "integer"
        },
        "total": {
          "format": "int32",
          "type": "integer"
        },
        "truncated": {
          "type": "boolean"
        }
      },
      "required": [
        "total",
        "returned",
        "truncated"
      ],
      "type": "object"
    },
    "HostVolumeResponse": {
      "properties": {
        "availableBytes": {
          "$ref": "#/$defs/CurrentMeasurementResponse"
        },
        "freeBytes": {
          "$ref": "#/$defs/CurrentMeasurementResponse"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "totalBytes": {
          "$ref": "#/$defs/CurrentMeasurementResponse"
        },
        "usedBytes": {
          "$ref": "#/$defs/CurrentMeasurementResponse"
        }
      },
      "required": [
        "id",
        "name",
        "usedBytes",
        "totalBytes",
        "freeBytes",
        "availableBytes"
      ],
      "type": "object"
    },
    "ImageSizeResponse": {
      "properties": {
        "height": {
          "format": "int32",
          "type": "integer"
        },
        "width": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "width",
        "height"
      ],
      "type": "object",
      "description": "A pixel size."
    },
    "ImportedConfigurationResponse": {
      "properties": {
        "observedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the host read them, by the host's clock."
        },
        "values": {
          "additionalProperties": {},
          "type": "object",
          "description": "Each value read, by console variable name; a setting not listed was not found on the server."
        }
      },
      "required": [
        "observedAt",
        "values"
      ],
      "type": "object",
      "description": "Values RustSC read from the server itself, in the same shapes as the saved values."
    },
    "InGameLinkingBody": {
      "properties": {
        "command": {
          "type": [
            "null",
            "string"
          ],
          "description": "The command players type in the game, without the slash: 1 to 32 of a to z, 0 to 9 and _, saved in lower case, not a plugin\nframework's own (oxide, o, c, carbon, umod). Left out or null keeps the workspace's current command."
        },
        "enabled": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True lets players link in the game (/link) on every server a host runs; false stops it."
        }
      },
      "type": "object",
      "description": "Body of `PUT /workspaces/{id}/in-game-linking`."
    },
    "InGameLinkingResponse": {
      "properties": {
        "command": {
          "type": [
            "null",
            "string"
          ],
          "description": "The command players type in the game, without the slash; `link` unless the workspace renamed it."
        },
        "enabled": {
          "type": "boolean",
          "description": "True when a server was saved as on."
        },
        "saved": {
          "type": "boolean",
          "description": "False until a form saved a choice; a new server reads linking as off until then."
        },
        "servers": {
          "format": "int32",
          "type": "integer",
          "description": "How many servers a host runs."
        }
      },
      "required": [
        "saved",
        "enabled",
        "servers"
      ],
      "type": "object",
      "description": "How the workspace's servers stand on linking in the game."
    },
    "InactivityResponse": {
      "properties": {
        "closed": {
          "type": "boolean",
          "description": "False while the workspace is only about to close; true once it has closed."
        },
        "closesAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the workspace closes, or when it closed."
        },
        "deletesAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When a closed workspace's data is deleted; absent before it closes."
        }
      },
      "required": [
        "closed",
        "closesAt"
      ],
      "type": "object",
      "description": "An unused free workspace that is about to close or has closed."
    },
    "InspectConfigurationRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        }
      },
      "type": "object",
      "description": "Request a read of the server's configuration."
    },
    "InspectEntityRequestBody": {
      "properties": {
        "generation": {
          "type": "string",
          "description": "The world generation from that row. A wipe changes it, and an entity of an earlier generation is never looked at."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the thing, only so the activity line says it; optional, up to 64 characters."
        },
        "netId": {
          "type": "string",
          "description": "The network ID from a find row, as text."
        }
      },
      "required": [
        "netId",
        "generation"
      ],
      "type": "object",
      "description": "Looks at one entity."
    },
    "InspectRootRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the host is offline; leave it out to refuse."
            }
          ]
        },
        "root": {
          "type": [
            "null",
            "string"
          ],
          "description": "The existing server folder on the host, an absolute path, for example `/srv/rust/example-server`."
        },
        "serverId": {
          "type": [
            "null",
            "string"
          ],
          "description": "A server in `adopt_failed` whose own folder is checked again (\"Use what is there now\"), for example `srv_01jb8z3k4q7v9w2x5y6z8a0b1c`: its folder is not\nrefused as taken. It must be on this host with this root. Leave it out for a folder no server holds."
        }
      },
      "type": "object",
      "description": "Inspects an existing server folder on a host before adopting it. Nothing is registered or written."
    },
    "InstallPluginRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "`oxide` or `carbon`; needed only when both are installed."
        },
        "marketplace": {
          "type": [
            "null",
            "string"
          ],
          "description": "The marketplace code: `umod`, or `codefling` for a plugin the workspace's own Codefling account owns (when RustSC offers the Codefling connection and the\nworkspace saved its key). Others answer `marketplace_not_available`."
        },
        "sha256": {
          "type": [
            "null",
            "string"
          ],
          "description": "Marketplace `address` only: the fingerprint (64 lower case hexadecimal characters) `checkPluginAddress` reported for the file at `source`. The host fetches\nthe address again and installs the file only while it is exactly this file."
        },
        "source": {
          "type": [
            "null",
            "string"
          ],
          "description": "The plugin's name as the marketplace writes it, or the address of its page there. For Codefling the listing id (a Find plugins result's `installSource`) or the\naddress of its page on codefling.com; refusals at `/source` name the reason (`codefling_not_connected`, `codefling_key_refused`, `codefling_not_allowed`,\n`codefling_not_owned`, `codefling_not_single_file`, `codefling_too_large`)."
        }
      },
      "type": "object",
      "description": "A plugin to install from a marketplace."
    },
    "InstallServerRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the host is busy or offline; leave it out to refuse."
            }
          ]
        },
        "branch": {
          "type": [
            "null",
            "string"
          ],
          "description": "The Steam branch; leave it out to keep the branch of the failed install."
        },
        "root": {
          "type": [
            "null",
            "string"
          ],
          "description": "A different folder to install into, for an install that failed because of the folder; leave it out to keep the server's folder."
        }
      },
      "type": "object",
      "description": "Installs again into a server whose install failed. Always checks every file."
    },
    "InstallUpdatesBody": {
      "properties": {
        "enabled": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "False stops installing updates with this schedule; absent means true."
        },
        "leadMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How long before the restart the install starts, 60 to 240 minutes; 120 by default."
        },
        "stopWindowsRestarting": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Let RustSC stop Windows restarting by itself; your previous settings come back when the updates stop. True by default."
        },
        "waitDays": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "0 (the default): install whatever is waiting. 1 to 30: only updates that have been waiting at least that many days."
        }
      },
      "type": "object",
      "description": "What a \"Restart host\" schedule does about Windows updates before its restart."
    },
    "InstallUpdatesResponse": {
      "properties": {
        "installDays": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": "array",
          "description": "The install days, ISO 1 Monday to 7 Sunday; empty is every day."
        },
        "installTime": {
          "type": "string",
          "description": "The local install time, `HH:mm`, in the schedule's time zone."
        },
        "leadMinutes": {
          "format": "int32",
          "type": "integer"
        },
        "stopWindowsRestarting": {
          "type": "boolean"
        },
        "waitDays": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "waitDays",
        "leadMinutes",
        "stopWindowsRestarting",
        "installTime",
        "installDays"
      ],
      "type": "object",
      "description": "A \"Restart host\" schedule's updates as saved, with the install time worked out from the restart time."
    },
    "InstallationConnectionResponse": {
      "properties": {
        "canScheduleOnDays": {
          "type": "boolean",
          "description": "Whether the host can run a schedule on several days of the week: it listed the feature the last time it connected, which is kept while it is off. False for a host with an older RustSC and for one that never connected; a form then offers one day only."
        },
        "connectedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the current connection started, UTC; null unless connected."
        },
        "lastContactAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The last time RustSC heard from the installation, UTC; null when it never connected."
        },
        "state": {
          "type": "string",
          "description": "`connected`, `disconnected` (it connected before) or `never_connected`. Treat unknown values as other. Local control on the host works in every state."
        },
        "unconfirmed": {
          "type": "boolean",
          "description": "True while RustSC cannot yet confirm the host is offline (`state` is `disconnected`). Show the last known state and do not show the host as offline. False or absent otherwise."
        }
      },
      "required": [
        "state",
        "connectedAt",
        "lastContactAt"
      ],
      "type": "object",
      "description": "The installation's connection to RustSC when the response was produced."
    },
    "InstallationRemovalResponse": {
      "properties": {
        "detachedServerIds": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The servers this removal detached; empty when it had already been removed."
        },
        "hostId": {
          "type": "string"
        },
        "hostRevision": {
          "format": "int64",
          "type": "integer",
          "description": "The host's revision after the removal."
        },
        "id": {
          "type": "string",
          "description": "Installation ID, for example `inst_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "state": {
          "type": "string",
          "description": "Always `removed`."
        }
      },
      "required": [
        "id",
        "state",
        "hostId",
        "hostRevision",
        "detachedServerIds"
      ],
      "type": "object",
      "description": "An installation after its removal and the servers it detached."
    },
    "InstallationResponse": {
      "properties": {
        "connection": {
          "$ref": "#/$defs/InstallationConnectionResponse",
          "description": "Whether the installation holds a live connection to RustSC."
        },
        "enrolledAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the installation enrolled, UTC."
        },
        "id": {
          "type": "string",
          "description": "Installation ID, for example `inst_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "keyThumbprint": {
          "type": "string",
          "description": "RFC 7638 thumbprint of the installation's public key, to compare with `rustsc status` on the host."
        },
        "osUpdates": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OsUpdatesResponse",
              "description": "The operating system updates waiting on the host, as the host last searched for them; null before the first search and for ever on a host that\ndoes not search (Linux). A read only fact: RustSC installs nothing and changes no setting."
            }
          ]
        },
        "powerOn": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PowerOnResponse",
              "description": "Whether the host was seen to start again by itself after an unexpected stop, as the host last reported it; null for a host that has not reported it (a host from before this\nfact), which the portal treats as not reported."
            }
          ]
        },
        "rebootRequired": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/RebootRequiredResponse",
              "description": "Whether the host's operating system says it needs a reboot, as the host last reported it; null before the first report."
            }
          ]
        },
        "softwareUpdate": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/SoftwareUpdateResponse",
              "description": "How RustSC itself is updated on the host and whether a newer version is waiting for it, as the host last reported it; null\nbefore the host has reported it (a host from before this fact) and the portal shows no switch then."
            }
          ]
        },
        "state": {
          "type": "string",
          "description": "`enrolled`, `replacement_pending`, `revoked`, `replaced` or `removed`. Treat unknown values as other."
        },
        "unusableSettingsFiles": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The names of the host's settings files it could not use since its service started, so it is using the default setting; absent when there are none or the host is\nfrom before this fact. A file name only, never its folder or the reason. The host page says what happened and the one thing to do."
        }
      },
      "required": [
        "id",
        "state",
        "keyThumbprint",
        "enrolledAt",
        "connection",
        "rebootRequired"
      ],
      "type": "object",
      "description": "An enrolled copy of the host service, identified by its key. The key itself never leaves the host."
    },
    "InstalledVersionResponse": {
      "properties": {
        "channel": {
          "type": [
            "null",
            "string"
          ],
          "description": "The Steam branch the files hold, or the framework's channel."
        },
        "known": {
          "type": "boolean",
          "description": "False when the version is not known, for example after an update that failed while it replaced files."
        },
        "label": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/BuildLabelResponse",
              "description": "For a supporting extension whose version is a build id (RustEdit): the publisher's name for that build. Absent when it is not read (a listing not read yet); see BuildLabelResponse. Display only."
            }
          ]
        },
        "observedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When it was reported, UTC."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why it is not known: `update_failed` or `install_incomplete`; for a framework `not_installed` or `change_failed`."
        },
        "source": {
          "type": "string",
          "description": "The source of the reported version."
        },
        "version": {
          "type": [
            "null",
            "string"
          ],
          "description": "The Steam build ID or the framework version, when known."
        }
      },
      "required": [
        "known",
        "channel",
        "version",
        "reason",
        "source",
        "observedAt"
      ],
      "type": "object",
      "description": "The installed version as the host verified it."
    },
    "IntegrationHostResponse": {
      "properties": {
        "id": {
          "type": "string",
          "description": "The host's ID (`host_...`, the one the host list shows), for Remove from this host. Not shown to the member."
        },
        "name": {
          "type": "string",
          "description": "The host's name."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why the host refused the key, set only when `state` is `refused`: `untrusted` (the host does not trust the cloud's signature: reconnect the host),\n`wrong_key`, `damaged` or `no_key` (the host could not read the key: save it again), `stale` or `storage_failed`. Absent otherwise."
        },
        "state": {
          "type": "string",
          "description": "`has_key` (the host reported it stored the key), `waiting` (the key is on its way, or the host must be reached again) or `refused` (the host could not keep the key)."
        }
      },
      "required": [
        "id",
        "name",
        "state"
      ],
      "type": "object",
      "description": "One host and where the key stands on it."
    },
    "IntegrationHostsResponse": {
      "properties": {
        "hosts": {
          "items": {
            "$ref": "#/$defs/IntegrationHostResponse"
          },
          "type": "array",
          "description": "The hosts that hold, wait for or refused the key, by name. Empty when no host has it."
        }
      },
      "required": [
        "hosts"
      ],
      "type": "object",
      "description": "The hosts that hold one key. A host is named, never numbered: a name is what the member knows it by."
    },
    "IntegrationItemResponse": {
      "properties": {
        "count": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "A number the words use: channels or webhooks that are on, hosts that hold a key."
        },
        "id": {
          "type": "string",
          "description": "`steam`, `codefling`, `discord`, `alert_channels` or `webhooks`."
        },
        "lastCheck": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/IntegrationLastCheckResponse",
              "description": "When the key was last checked and how it ended, for the Steam key and the Codefling account. Null until a check was made since the key was saved or replaced."
            }
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "A name the words use: the Discord server the bot is in."
        },
        "runsFrom": {
          "type": "string",
          "description": "Where the integration runs, either `rustsc` or `host`."
        },
        "runsFromReason": {
          "type": [
            "null",
            "string"
          ],
          "description": "When `runsFrom` is `rustsc` for a reason the member can act on: `host_needs_update` or `host_lacks_key`. Null otherwise."
        },
        "state": {
          "type": "string",
          "description": "`working` (set up), `not_set_up` (nothing saved or connected yet) or `attention` (something to fix)."
        },
        "status": {
          "type": "string",
          "description": "The words of the row, as a code the portal words: `key_saved`, `key_refused` (a host says Steam did not accept it), `needs_key`, `connected`,\n`needs_channel`, `needs_attention`, `not_connected`, `channels_on`, `no_channel`, `webhooks_on`, `none_yet`, `last_failed`."
        },
        "updatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the key was last saved, for the integrations that hold one; null otherwise."
        }
      },
      "required": [
        "id",
        "state",
        "status",
        "runsFrom"
      ],
      "type": "object",
      "description": "One integration's stored state. It comes from what RustSC already holds: reading it asks no outside service."
    },
    "IntegrationLastCheckResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": "string",
          "description": "When the check was made."
        },
        "detail": {
          "type": [
            "null",
            "string"
          ],
          "description": "What the other side answered, as a word the portal words: `http_403` or `http_503` (the status it answered), `rate_limited`, `timeout` or `steam_error`. Null when the check kept none (a check made before this was kept, or one whose integration does not keep it yet)."
        },
        "result": {
          "type": "string",
          "description": "`works` (the third party accepted the key), `refused` (it did not) or `no_answer` (it did not answer, so nothing is known about the key)."
        }
      },
      "required": [
        "at",
        "result"
      ],
      "type": "object",
      "description": "When a key was last checked (a Send test, a Check, or the check that follows saving a Codefling key) and how it ended."
    },
    "IntegrationListResponse": {
      "properties": {
        "hasHosts": {
          "type": "boolean",
          "description": "Whether the workspace has at least one host. The screen shows its \"no host yet\" line only while this is false."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/IntegrationItemResponse"
          },
          "type": "array",
          "description": "The integrations that keep state, in screen order. Links to other pages (API keys, assistants, Plugin Marketplaces) are not listed here."
        }
      },
      "required": [
        "hasHosts",
        "items"
      ],
      "type": "object",
      "description": "The Integrations list: the workspace's accounts and keys with a few words of status each."
    },
    "InventoryContainerResponse": {
      "properties": {
        "capacity": {
          "format": "int32",
          "type": "integer",
          "description": "How many slots it has."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/InventoryItemResponse"
          },
          "type": "array"
        },
        "name": {
          "type": "string",
          "description": "`main`, `belt` or `wear`."
        },
        "parentUid": {
          "type": [
            "null",
            "string"
          ],
          "description": "The equipped native backpack item's UID, when this is its contents."
        }
      },
      "required": [
        "name",
        "capacity",
        "items"
      ],
      "type": "object",
      "description": "One container of a player."
    },
    "InventoryEditChangeBody": {
      "properties": {
        "amount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "clientId": {
          "type": "string"
        },
        "container": {
          "type": [
            "null",
            "string"
          ]
        },
        "deleteContents": {
          "type": [
            "null",
            "boolean"
          ]
        },
        "item": {
          "type": [
            "null",
            "string"
          ]
        },
        "kind": {
          "type": "string"
        },
        "uid": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "clientId",
        "kind"
      ],
      "type": "object",
      "description": "One change keyed by a stable client ID so a partial result maps back to its original row."
    },
    "InventoryItemResponse": {
      "properties": {
        "amount": {
          "format": "int32",
          "type": "integer"
        },
        "conditionPercent": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Condition as a percentage, for an item that wears out."
        },
        "contentsCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Direct nested items, such as attachments or backpack contents; null when no child container exists."
        },
        "displayName": {
          "type": "string",
          "description": "The item's English name."
        },
        "held": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True for the item in the player's hands."
        },
        "item": {
          "type": "string"
        },
        "maxStackable": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The game's effective stack limit for this exact item, including modded rules and an existing larger amount."
        },
        "skin": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The skin number; null when none."
        },
        "slot": {
          "format": "int32",
          "type": "integer",
          "description": "The slot in its container, from 0."
        },
        "uid": {
          "type": "string",
          "description": "The item's unique number in this game session, as text; keep it a string."
        }
      },
      "required": [
        "uid",
        "item",
        "displayName",
        "amount",
        "slot"
      ],
      "type": "object",
      "description": "One stack a player carries."
    },
    "InvitationAcceptedResponse": {
      "properties": {
        "workspaceId": {
          "type": "string"
        }
      },
      "required": [
        "workspaceId"
      ],
      "type": "object",
      "description": "The workspace a person joined by accepting."
    },
    "InvitationLinkBody": {
      "properties": {
        "token": {
          "type": "string",
          "description": "The token of the link."
        },
        "workspaceId": {
          "type": "string",
          "description": "Workspace ID."
        }
      },
      "required": [
        "workspaceId",
        "token"
      ],
      "type": "object",
      "description": "The link of an invitation: the workspace and the token after the `#` of the address in the email."
    },
    "InvitationListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/InvitationResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "Always null: the list is returned in one page."
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The number of items."
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount"
      ],
      "type": "object",
      "description": "The pending invitations, newest first."
    },
    "InvitationOfferResponse": {
      "properties": {
        "hosts": {
          "format": "int32",
          "type": "integer",
          "description": "How many hosts the person may see, read-only; 0 when none."
        },
        "serverRoles": {
          "items": {
            "$ref": "#/$defs/InvitationOfferedRoleResponse"
          },
          "type": "array"
        },
        "workspaceId": {
          "type": "string"
        },
        "workspaceName": {
          "type": "string"
        },
        "workspaceRole": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/InvitationOfferedRoleResponse"
            }
          ]
        }
      },
      "required": [
        "workspaceId",
        "workspaceName",
        "workspaceRole",
        "serverRoles",
        "hosts"
      ],
      "type": "object",
      "description": "What accepting an invitation gives, for the signed-in person whose address was invited."
    },
    "InvitationOfferedRoleResponse": {
      "properties": {
        "name": {
          "type": "string",
          "description": "The role's name as the workspace knows it."
        },
        "preset": {
          "type": [
            "null",
            "string"
          ],
          "description": "`owner`, `administrator`, `operator`, `moderator` or `viewer` for a preset; null for a custom role."
        },
        "servers": {
          "format": "int32",
          "type": "integer",
          "description": "For a role on servers, how many servers; 0 for the role in the whole workspace."
        }
      },
      "required": [
        "name",
        "preset",
        "servers"
      ],
      "type": "object",
      "description": "A role an invitation carries, as the page of the invitation shows it."
    },
    "InvitationResponse": {
      "properties": {
        "email": {
          "type": "string",
          "description": "The invited address, in lower case."
        },
        "expired": {
          "type": "boolean",
          "description": "True when `expiresAt` has passed. An expired invitation stays listed until it is sent again or withdrawn."
        },
        "expiresAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the link stops working."
        },
        "hosts": {
          "items": {
            "$ref": "#/$defs/InvitedHostResponse"
          },
          "type": "array",
          "description": "The hosts the person may see once they accept, read-only; empty when none were chosen."
        },
        "id": {
          "type": "string",
          "description": "Invitation ID, for example `inv_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "sentAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the invitation was last sent."
        },
        "servers": {
          "items": {
            "$ref": "#/$defs/InvitedServerResponse"
          },
          "type": "array",
          "description": "The roles on single servers."
        },
        "workspaceRoleId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The role for the whole workspace, or null when the invitation is only for servers."
        }
      },
      "required": [
        "id",
        "email",
        "workspaceRoleId",
        "servers",
        "hosts",
        "sentAt",
        "expiresAt",
        "expired"
      ],
      "type": "object",
      "description": "A pending invitation: who is invited, to what, and until when."
    },
    "InvitationSentResponse": {
      "properties": {
        "emailSent": {
          "type": "boolean",
          "description": "True when the email was accepted for delivery. False leaves the invitation pending: send it again."
        },
        "invitation": {
          "$ref": "#/$defs/InvitationResponse"
        }
      },
      "required": [
        "invitation",
        "emailSent"
      ],
      "type": "object",
      "description": "An invitation that was made or sent again, and whether its email was handed to the email provider."
    },
    "InvitedHostResponse": {
      "properties": {
        "hostId": {
          "type": "string"
        }
      },
      "required": [
        "hostId"
      ],
      "type": "object",
      "description": "One host an invitation lets the person see."
    },
    "InvitedServerResponse": {
      "properties": {
        "roleId": {
          "type": "string"
        },
        "serverId": {
          "type": "string"
        }
      },
      "required": [
        "serverId",
        "roleId"
      ],
      "type": "object",
      "description": "One role an invitation gives on one server."
    },
    "IssueEnrollmentTokenRequestBody": {
      "properties": {
        "hostId": {
          "type": [
            "null",
            "string"
          ],
          "description": "A full host of this workspace to enroll a replacement installation on, for example\n`host_01jb8z3k4q7v9w2x5y6z8a0b1c`. Absent or null for a token that adds a new host."
        },
        "sendHostLog": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True when the Add host form was saved with \"Send this host's log to the portal\" ticked (the form pre-fills it ticked). A token that adds a new host then enrolls it with the choice\nsaved on and tells it; a token for an existing host ignores it. Absent or false saves nothing: a host sends nothing to the portal until a member saves the switch."
        }
      },
      "type": "object",
      "description": "Create an enrollment token. Send `{}` for a token that adds a new host."
    },
    "IssuedEnrollmentTokenResponse": {
      "properties": {
        "cloudUrl": {
          "type": "string",
          "description": "The https address to enroll at, for `rustsc enroll --cloud &lt;cloudUrl&gt;`. Run the command\non the host and paste the token when it asks, or pass it with `--token-file`; never put\nthe token on the command line."
        },
        "enrollmentToken": {
          "$ref": "#/$defs/EnrollmentTokenResponse",
          "description": "The token. Its text is present only in the response that created it."
        }
      },
      "required": [
        "enrollmentToken",
        "cloudUrl"
      ],
      "type": "object",
      "description": "A created enrollment token with the address hosts use it at."
    },
    "ItemSetLineBody": {
      "properties": {
        "amount": {
          "format": "int32",
          "type": "integer",
          "description": "How many to give, 1 to 100,000."
        },
        "item": {
          "type": "string"
        },
        "skin": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "A skin number, or left out for none."
        }
      },
      "required": [
        "item",
        "amount"
      ],
      "type": "object",
      "description": "One line of an item set: an item and how many."
    },
    "ItemSetResponse": {
      "properties": {
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "createdBy": {
          "$ref": "#/$defs/OperationActorResponse"
        },
        "id": {
          "type": "string",
          "description": "The set's ID (`ist_...`)."
        },
        "lines": {
          "items": {
            "$ref": "#/$defs/ItemSetLineBody"
          },
          "type": "array"
        },
        "name": {
          "type": "string"
        },
        "revision": {
          "format": "int32",
          "type": "integer",
          "description": "1 at creation, one more at every edit. Also the `ETag` of a single read, create or edit answer; send it back in `If-Match` to change or delete the set."
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        },
        "updatedBy": {
          "$ref": "#/$defs/OperationActorResponse"
        }
      },
      "required": [
        "id",
        "name",
        "lines",
        "revision",
        "createdAt",
        "createdBy",
        "updatedAt",
        "updatedBy"
      ],
      "type": "object",
      "description": "One saved item set."
    },
    "ItemSetsResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/ItemSetResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object",
      "description": "The saved item sets of a server."
    },
    "JoinCheckResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "identity": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/SteamIdentityResponse",
              "description": "Null when Steam was not asked for this join, or without `players.read.sensitive` (`masked`)."
            }
          ]
        },
        "masked": {
          "type": "boolean",
          "description": "True when the reader lacks `players.read.sensitive`: the Steam facts and the country are left out."
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "policyRevision": {
          "format": "int64",
          "type": "integer",
          "description": "The revision of the rules that were applied."
        },
        "refusedBy": {
          "type": [
            "null",
            "string"
          ],
          "description": "The rule that decided, when the result is refused."
        },
        "removal": {
          "type": "string",
          "description": "`removed` (the game confirmed the player left), `failed` (a refusal the game did not confirm) or `none`."
        },
        "result": {
          "type": "string",
          "description": "`allowed` or `refused`."
        },
        "stages": {
          "items": {
            "$ref": "#/$defs/JoinCheckStageResponse"
          },
          "type": "array"
        },
        "steamId": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "steamId",
        "at",
        "policyRevision",
        "result",
        "removal",
        "stages",
        "masked"
      ],
      "type": "object",
      "description": "One join check: what the rules decided for a player who joined, and why."
    },
    "JoinCheckStageResponse": {
      "properties": {
        "list": {
          "type": [
            "null",
            "string"
          ],
          "description": "For the `ban_lists` rule, the list this turn asked: `steam` or a community list's ID. Null for the other rules and for Allowed anyway."
        },
        "outcome": {
          "type": "string",
          "description": "`passed`, `refused` or `unknown` (never reported as a pass)."
        },
        "rule": {
          "type": "string",
          "description": "`allowlist`, `country`, `ban_lists`, `private_profile` or `account_age` (`steam_bans` in a check made before the ban lists existed)."
        },
        "unknownAs": {
          "type": [
            "null",
            "string"
          ],
          "description": "The owner's choice that was applied when the outcome is unknown: `allow` or `refuse`."
        },
        "value": {
          "type": [
            "null",
            "string"
          ],
          "description": "The value the rule used (a country code, a ban count, an age in days). Null without `players.read.sensitive` or when there was none."
        }
      },
      "required": [
        "rule",
        "outcome"
      ],
      "type": "object",
      "description": "One rule's turn in a join check."
    },
    "JoinChecksResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/JoinCheckResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "Pass as `cursor` with the same filters for the next page; null on the last page."
        }
      },
      "required": [
        "items"
      ],
      "type": "object",
      "description": "A page of join checks, newest first."
    },
    "JoinRulePreviewServerResponse": {
      "properties": {
        "rules": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "serverId": {
          "type": "string"
        },
        "serverName": {
          "type": "string"
        }
      },
      "required": [
        "serverId",
        "serverName",
        "rules"
      ],
      "type": "object",
      "description": "A server a default would newly apply to, with the rules (`country`, `private_profile`, `account_age`)."
    },
    "JoinRuleServerResponse": {
      "properties": {
        "serverId": {
          "type": "string"
        },
        "serverName": {
          "type": "string"
        },
        "sources": {
          "$ref": "#/$defs/JoinRuleSourcesBody"
        }
      },
      "required": [
        "serverId",
        "serverName",
        "sources"
      ],
      "type": "object",
      "description": "One server with a host and where its values for the shared rules come from."
    },
    "JoinRuleSettingsBody": {
      "properties": {
        "countries": {
          "$ref": "#/$defs/CountryRuleBody"
        },
        "steam": {
          "$ref": "#/$defs/SteamRulesBody"
        }
      },
      "required": [
        "countries",
        "steam"
      ],
      "type": "object",
      "description": "The workspace's default for the join rules that can apply to every server (`GET and PUT .../join-rule-settings`): blocked countries, Steam profile must be public and\nthe minimum Steam account age. A server follows these unless it holds its own value for a rule."
    },
    "JoinRuleSettingsPreviewResponse": {
      "properties": {
        "servers": {
          "items": {
            "$ref": "#/$defs/JoinRulePreviewServerResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "servers"
      ],
      "type": "object",
      "description": "The servers that would start refusing players if the defaults in the body were saved: they follow the workspace for a rule that is off on them today."
    },
    "JoinRuleSettingsResponse": {
      "properties": {
        "countries": {
          "$ref": "#/$defs/CountryRuleBody"
        },
        "servers": {
          "items": {
            "$ref": "#/$defs/JoinRuleServerResponse"
          },
          "type": "array"
        },
        "steam": {
          "$ref": "#/$defs/SteamRulesBody"
        },
        "updatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "countries",
        "steam",
        "servers"
      ],
      "type": "object",
      "description": "The workspace's join rule defaults and the servers that use them. `updatedAt` is null before the workspace first changed one, when every default is off. Servers\nwithout a host are not listed: the rules need the game's host service."
    },
    "JoinRuleSourcesBody": {
      "properties": {
        "accountAge": {
          "type": "string"
        },
        "countries": {
          "type": "string"
        },
        "privateProfile": {
          "type": "string"
        }
      },
      "required": [
        "countries",
        "privateProfile",
        "accountAge"
      ],
      "type": "object",
      "description": "Where the value a server uses for each shared rule comes from: `workspace` or `server`."
    },
    "JoinRulesResponse": {
      "properties": {
        "allowlist": {
          "$ref": "#/$defs/AllowlistRuleBody"
        },
        "countries": {
          "$ref": "#/$defs/CountryRuleBody"
        },
        "latency": {
          "$ref": "#/$defs/LatencyRuleBody"
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "The saved revision; 0 before the first save."
        },
        "serverId": {
          "type": "string"
        },
        "serverName": {
          "type": "string"
        },
        "sources": {
          "$ref": "#/$defs/JoinRuleSourcesBody",
          "description": "Where the value of blocked countries, a public Steam profile and the Steam account age comes from: the workspace's default or this server's own value."
        },
        "steam": {
          "$ref": "#/$defs/SteamRulesBody"
        },
        "steamProblem": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why Steam last gave no answer, from the newest join that asked it: `unavailable` (RustSC could not ask Steam right now), `rate_limited`,\n`timeout`, `steam_error`, `backing_off`, `not_listed`, or, only for a host that asks Steam with its own key file,\n`no_key` or `rejected_key`. Null when Steam answered or was not asked yet."
        },
        "steamProblemAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "supported": {
          "type": "boolean"
        },
        "updatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "workspace": {
          "$ref": "#/$defs/JoinRuleSettingsBody",
          "description": "The workspace's default for those three rules, to show beside the server's own value."
        }
      },
      "required": [
        "serverId",
        "serverName",
        "supported",
        "revision",
        "allowlist",
        "countries",
        "steam",
        "latency",
        "sources",
        "workspace"
      ],
      "type": "object",
      "description": "A server's join rules. A player who breaks a rule is removed shortly after joining; owners and moderators of the\ngame are never removed; every rule is off until switched on. `supported` is false on a server without a host service."
    },
    "JsonElement": {},
    "KickPlayerRequestBody": {
      "properties": {
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why, shown to the player; optional, up to 200 characters. Quotes, backslashes, semicolons and line breaks are replaced with look-alikes."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID of the player to kick, 17 digits. A name never selects a player."
        }
      },
      "required": [
        "steamId"
      ],
      "type": "object",
      "description": "Kicks one player: the Steam ID and an optional reason."
    },
    "KillPlayerRequestBody": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the player, only so the activity line says it; optional."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID of the player, 17 digits."
        }
      },
      "required": [
        "steamId"
      ],
      "type": "object",
      "description": "Kills one connected player."
    },
    "LatencyRuleBody": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "maxMs": {
          "format": "int32",
          "type": "integer",
          "description": "1 to 5000 milliseconds."
        },
        "message": {
          "type": "string"
        }
      },
      "required": [
        "enabled",
        "maxMs",
        "message"
      ],
      "type": "object",
      "description": "Players whose latency stays above `maxMs` milliseconds for three samples in a row are removed after they join. Off by default; it is a check of\nplayers already in the game, never a refusal at login."
    },
    "LatestCandidatesResponse": {
      "properties": {
        "batch": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/CandidateBatchResponse"
            }
          ]
        }
      },
      "type": "object",
      "description": "The newest batch of the workspace, or none."
    },
    "LatestVersionResponse": {
      "properties": {
        "channel": {
          "type": "string"
        },
        "checkedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the newest check ended, UTC."
        },
        "label": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/BuildLabelResponse",
              "description": "For a supporting extension whose version is a build id (RustEdit): the publisher's name for the latest build. Absent when it is not read. Display only."
            }
          ]
        },
        "publishedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When Steam last changed the branch, UTC, if it says."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why the channel is unavailable or the check failed."
        },
        "retrievedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When `version` was read, UTC."
        },
        "state": {
          "type": "string",
          "description": "`available`, `unavailable` or `failed`, for the newest check."
        },
        "version": {
          "type": [
            "null",
            "string"
          ],
          "description": "The newest build read for the channel; after a failed check it is the one an earlier check read."
        }
      },
      "required": [
        "channel",
        "state",
        "reason",
        "version",
        "publishedAt",
        "retrievedAt",
        "checkedAt"
      ],
      "type": "object",
      "description": "The platform's newest read of a channel with the newest build it read (one shared record for every workspace)."
    },
    "LaunchBaselineArgumentResponse": {
      "properties": {
        "kind": {
          "type": "string",
          "description": "`known` (RustSC knows it), `other` (listed as found) or `unresolved` (its value comes from a variable or command the file does not set). Treat unknown values as other."
        },
        "name": {
          "type": "string",
          "description": "The argument with its sign, for example `+server.port` or `-batchmode`."
        },
        "source": {
          "type": "string",
          "description": "The file it came from, relative to the server folder."
        },
        "value": {
          "type": [
            "null",
            "string"
          ],
          "description": "Its value as written with secrets hidden (a link shows its host and file name only); null for a flag and for an unresolved argument."
        }
      },
      "required": [
        "source",
        "name",
        "kind"
      ],
      "type": "object",
      "description": "One launch argument read from a start script or LinuxGSM file."
    },
    "LaunchBaselineResponse": {
      "properties": {
        "arguments": {
          "items": {
            "$ref": "#/$defs/LaunchBaselineArgumentResponse"
          },
          "type": "array",
          "description": "In the order found. Never applied by RustSC."
        },
        "secretsLeftOut": {
          "type": "boolean",
          "description": "True when the RCON password or salt was in the files and was left out on purpose: RustSC keeps its own RCON password for the server."
        },
        "skippedWords": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Words of how the server was started that RustSC did not carry over, as they were written with secrets hidden (a link shows its host and file name only). Empty when nothing was left out."
        },
        "world": {
          "items": {
            "$ref": "#/$defs/LaunchBaselineWorldResponse"
          },
          "type": "array",
          "description": "The values that decide which world the server loads, each with where RustSC read it from (the running game, your start script or your game manager's settings), in plain words. Empty when none was read."
        }
      },
      "required": [
        "arguments",
        "secretsLeftOut",
        "skippedWords",
        "world"
      ],
      "type": "object",
      "description": "The launch arguments an adoption imported as the server's starting state."
    },
    "LaunchBaselineWorldResponse": {
      "properties": {
        "from": {
          "type": "string",
          "description": "Where it was read from: the running game, your start script or your game manager's settings."
        },
        "label": {
          "type": "string",
          "description": "What it is: Map link, Map, Map size, Seed or Save folder."
        },
        "value": {
          "type": [
            "null",
            "string"
          ],
          "description": "The value as the reader may see it (a link shows its host and file name only); null for a flag."
        }
      },
      "required": [
        "label",
        "from"
      ],
      "type": "object",
      "description": "One value that decides which world loads, and where it was read from."
    },
    "LaunchFlagResponse": {
      "properties": {
        "flag": {
          "type": "string",
          "description": "The exact switch, for example `-silent-crashes`."
        }
      },
      "required": [
        "flag"
      ],
      "type": "object",
      "description": "One startup flag."
    },
    "LaunchInputsBody": {
      "properties": {
        "clear": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The settings whose saved value is removed, by name: `saveFolderName`, `gamePort`, `queryPort`, `consolePort`. Anything else is 422 on `/clear`."
        },
        "consolePort": {
          "type": [
            "null",
            "string"
          ],
          "description": "The console port (TCP, this host only): a whole number 1024 to 65535."
        },
        "gamePort": {
          "type": [
            "null",
            "string"
          ],
          "description": "The game port (UDP): a whole number 1024 to 65535, different from the query port."
        },
        "queryPort": {
          "type": [
            "null",
            "string"
          ],
          "description": "The server query port (UDP): a whole number 1024 to 65535, different from the game port."
        },
        "saveFolderName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The folder under `server/` that holds the world and the player data: 1 to 64 letters, digits, `_` or `-`, not starting with `-`."
        }
      },
      "type": "object",
      "description": "Start settings to save for a server RustSC does not run yet (`PUT .../launch-inputs`). Each member is optional: a text saves it and a member left out keeps what is saved. `clear` names the settings whose saved value is removed. The console password is not here; it has its own field on the Configuration page."
    },
    "LaunchInputsResponse": {
      "properties": {
        "consolePort": {
          "type": [
            "null",
            "string"
          ],
          "description": "The saved console port; null when none is saved."
        },
        "delivery": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResponse",
              "description": "The operation that gives the saved settings to the host, as it is now; null when never saved."
            }
          ]
        },
        "gamePort": {
          "type": [
            "null",
            "string"
          ],
          "description": "The saved game port; null when none is saved."
        },
        "queryPort": {
          "type": [
            "null",
            "string"
          ],
          "description": "The saved query port; null when none is saved."
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "Raised by every save that changes something; 0 means never saved."
        },
        "saveFolderName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The saved save folder name; null when none is saved."
        },
        "updatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the settings were last saved, UTC; null when never saved."
        }
      },
      "required": [
        "saveFolderName",
        "gamePort",
        "queryPort",
        "consolePort",
        "revision",
        "updatedAt",
        "delivery"
      ],
      "type": "object",
      "description": "The start settings saved for a server that RustSC does not run yet; they are used when RustSC starts it."
    },
    "LinkChannelGroupResponse": {
      "properties": {
        "category": {
          "type": [
            "null",
            "string"
          ],
          "description": "The category name; null for channels outside every category."
        },
        "channels": {
          "items": {
            "$ref": "#/$defs/LinkChannelResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "channels"
      ],
      "type": "object"
    },
    "LinkChannelListResponse": {
      "properties": {
        "groups": {
          "items": {
            "$ref": "#/$defs/LinkChannelGroupResponse"
          },
          "type": "array"
        },
        "readAt": {
          "format": "date-time",
          "type": "string",
          "description": "When Discord was read; the page says \"Updated just now\" from it."
        },
        "total": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "readAt",
        "total",
        "groups"
      ],
      "type": "object",
      "description": "The text channels of the connected Discord server, grouped by category, read from Discord when this was asked for."
    },
    "LinkChannelResponse": {
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "LinkUploadResponse": {
      "properties": {
        "alreadyLinked": {
          "format": "int32",
          "type": "integer",
          "description": "Players already linked here exactly like the file says."
        },
        "created": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Links made, once imported."
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "expiresAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the kept file is deleted if nothing happens first."
        },
        "found": {
          "format": "int32",
          "type": "integer",
          "description": "Players the file names (ready)."
        },
        "id": {
          "type": "string"
        },
        "leftOut": {
          "format": "int32",
          "type": "integer",
          "description": "Lines left out: not readable, contradicting each other, or disagreeing with a link that is already active."
        },
        "state": {
          "type": "string"
        },
        "wouldCreate": {
          "format": "int32",
          "type": "integer",
          "description": "Links that confirming would make (ready), from the dry run."
        }
      },
      "required": [
        "id",
        "state",
        "createdAt",
        "expiresAt",
        "found",
        "wouldCreate",
        "alreadyLinked",
        "leftOut"
      ],
      "type": "object",
      "description": "One uploaded file as the member sees it. `state` is `ready` (understood; the counts say what confirming will do),\n`unrecognised` (kept so the owner can add the format; a support request is open), `imported` or `removed`. Never the file and never an ID."
    },
    "LinkUploadsResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/LinkUploadResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object",
      "description": "The workspace's latest uploads, newest first."
    },
    "LinkedGroupChoiceResponse": {
      "properties": {
        "name": {
          "type": "string"
        },
        "staff": {
          "type": "boolean"
        }
      },
      "required": [
        "name",
        "staff"
      ],
      "type": "object"
    },
    "LinkedGroupChoicesResponse": {
      "properties": {
        "groups": {
          "items": {
            "$ref": "#/$defs/LinkedGroupChoiceResponse"
          },
          "type": "array"
        },
        "rustConnected": {
          "type": "boolean"
        },
        "servers": {
          "items": {
            "$ref": "#/$defs/LinkedGroupServerResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "rustConnected",
        "servers",
        "groups"
      ],
      "type": "object",
      "description": "The servers of the workspace and the groups of the one asked for, for the group picker. `staff` groups are listed and cannot be chosen."
    },
    "LinkedGroupResponse": {
      "properties": {
        "added": {
          "format": "int32",
          "type": "integer"
        },
        "alreadyIn": {
          "format": "int32",
          "type": "integer"
        },
        "cannotConfirmSince": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "failed": {
          "format": "int32",
          "type": "integer"
        },
        "group": {
          "type": "string"
        },
        "notAdded": {
          "format": "int32",
          "type": "integer"
        },
        "problem": {
          "type": [
            "null",
            "string"
          ]
        },
        "removing": {
          "type": "boolean"
        },
        "serverId": {
          "type": "string"
        },
        "serverName": {
          "type": "string"
        }
      },
      "required": [
        "serverId",
        "serverName",
        "group",
        "removing",
        "added",
        "alreadyIn",
        "failed",
        "notAdded"
      ],
      "type": "object",
      "description": "A Rust group a linked-players rule also adds players to on one server. `added` were put in the group, `alreadyIn` were in it already (and stay), `failed` were refused by the server,\n`notAdded` linked before the group was chosen and are added only by \"Add players who already linked\". `problem` says why nobody can be added now:\n`group_missing`, `group_is_staff`, `managed_by_sync` or `cannot_add`; `cannotConfirmSince` is set while the game has not answered, and nobody is taken out then."
    },
    "LinkedGroupServerResponse": {
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "ListedMeasurementsResponse": {
      "properties": {
        "fps": {
          "$ref": "#/$defs/CurrentMeasurementResponse"
        },
        "players": {
          "$ref": "#/$defs/CurrentMeasurementResponse"
        }
      },
      "required": [
        "players",
        "fps"
      ],
      "type": "object",
      "description": "What a list row shows of a running server: the last stored player count and frame rate. A value never seen has freshness unknown; an old one, stale."
    },
    "ListingNoticeResponse": {
      "properties": {
        "code": {
          "type": "string",
          "description": "`name_cut`, `description_cut`, `tags_unknown`, `tags_too_many`, `tags_same_group` or `tags_duplicate`. Treat unknown values as other."
        },
        "count": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The measured size or count, for the cut codes and `tags_too_many`; otherwise null."
        },
        "items": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The tags involved, for the tag codes; otherwise null."
        },
        "key": {
          "type": "string",
          "description": "The console variable, for example `server.hostname`."
        },
        "limit": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The cut-off exceeded, when the code has one; otherwise null."
        }
      },
      "required": [
        "key",
        "code",
        "count",
        "limit",
        "items"
      ],
      "type": "object",
      "description": "Something players will notice about the saved listing."
    },
    "LoginResponse": {
      "properties": {
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "displayName": {
          "type": "string",
          "description": "The name shown for the provider account: the Google address or the Discord name."
        },
        "lastUsedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "provider": {
          "type": "string"
        },
        "providerName": {
          "type": "string"
        }
      },
      "required": [
        "provider",
        "providerName",
        "displayName",
        "createdAt",
        "lastUsedAt"
      ],
      "type": "object",
      "description": "A linked Google or Discord account."
    },
    "ManagePlayerInventoryRequestBody": {
      "properties": {
        "changes": {
          "items": {
            "$ref": "#/$defs/InventoryEditChangeBody"
          },
          "type": "array"
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "revision": {
          "type": "string"
        },
        "steamId": {
          "type": "string"
        }
      },
      "required": [
        "steamId",
        "revision",
        "changes"
      ],
      "type": "object",
      "description": "One saved list of inventory edits; no game change occurs until this operation runs."
    },
    "MapBiomesResponse": {
      "properties": {
        "desert": {
          "format": "double",
          "type": "number"
        },
        "forest": {
          "format": "double",
          "type": "number"
        },
        "jungle": {
          "format": "double",
          "type": "number"
        },
        "snow": {
          "format": "double",
          "type": "number"
        },
        "tundra": {
          "format": "double",
          "type": "number"
        }
      },
      "required": [
        "snow",
        "desert",
        "forest",
        "tundra",
        "jungle"
      ],
      "type": "object"
    },
    "MapChoicesResponse": {
      "properties": {
        "builtIn": {
          "items": {
            "$ref": "#/$defs/BuiltInMapResponse"
          },
          "type": "array",
          "description": "The maps the game bundles that RustSC offers, in display order."
        },
        "maxMapBytes": {
          "format": "int64",
          "type": "integer",
          "description": "The largest custom map accepted, in bytes."
        },
        "maxUrlLength": {
          "format": "int32",
          "type": "integer",
          "description": "The longest custom map address accepted, in characters."
        },
        "previews": {
          "$ref": "#/$defs/MapPreviewSourceResponse",
          "description": "Whether previews can be shown and who they come from. Choosing a map never depends on it."
        },
        "worldSize": {
          "$ref": "#/$defs/MapSizeResponse",
          "description": "The size of a generated map, in metres."
        }
      },
      "required": [
        "builtIn",
        "worldSize",
        "maxUrlLength",
        "maxMapBytes",
        "previews"
      ],
      "type": "object",
      "description": "The choices Add server and Wipe map offer for a map."
    },
    "MapFactsResponse": {
      "properties": {
        "biomes": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/MapBiomesResponse",
              "description": "The share of the land per biome, 0 to 100."
            }
          ]
        },
        "islands": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "lakes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "landPercent": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The share of the map that is land, 0 to 100."
        },
        "monuments": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "mountains": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "rivers": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        }
      },
      "type": "object"
    },
    "MapNameBody": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name shown in the game's server list (with the companion plugin) and in Discord: letters, digits, spaces and . , ' ! ? &amp; + - ( ) only, up to 31 UTF-8 bytes,\nstarting with a letter or digit, never containing the word \"official\" in any form. Null or an empty text clears the name."
        },
        "showInList": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "False keeps the name out of the game's server list (Discord still uses it). Absent or true shows it."
        }
      },
      "type": "object",
      "description": "A server's map name to store. Saving it changes nothing on the server's files or process."
    },
    "MapNameResponse": {
      "properties": {
        "delivery": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResponse"
            }
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The saved name, or null for none."
        },
        "pluginInstalled": {
          "type": "boolean",
          "description": "The companion plugin is in the server's plugin list. Without it the name is used by Discord only; the server list needs the plugin."
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "Raised by every save of the name or the switch and by a wipe that names a map; 0 means never set."
        },
        "showInList": {
          "type": "boolean",
          "description": "Whether the name is shown in the game's server list. True unless switched off."
        }
      },
      "required": [
        "name",
        "showInList",
        "pluginInstalled",
        "revision",
        "delivery"
      ],
      "type": "object",
      "description": "A server's map name."
    },
    "MapPreviewImageResponse": {
      "properties": {
        "fullUrl": {
          "type": "string",
          "description": "The larger picture with the monument names, an address under this API."
        },
        "thumbnailUrl": {
          "type": "string",
          "description": "A small picture, an address under this API."
        }
      },
      "required": [
        "thumbnailUrl",
        "fullUrl"
      ],
      "type": "object"
    },
    "MapPreviewResponse": {
      "properties": {
        "facts": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/MapFactsResponse"
            }
          ]
        },
        "fetchedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When RustSC read the facts from the service; their age is shown."
        },
        "image": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/MapPreviewImageResponse",
              "description": "Where the picture is served from RustSC, when ready."
            }
          ]
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `none`: `no_map` or `being_made`. For `unavailable`: `not_configured`, `service_unavailable`,\n`key_rejected`, `rate_limited` or `too_many_requests`."
        },
        "seed": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The map's seed, when ready."
        },
        "size": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The map's size in metres, when ready."
        },
        "sourceUrl": {
          "type": [
            "null",
            "string"
          ],
          "description": "The map's page at the service, linked from the attribution."
        },
        "state": {
          "type": "string",
          "description": "`ready`, `none` (the service has no map for this seed yet) or `unavailable` (previews cannot be shown right now)."
        }
      },
      "required": [
        "state"
      ],
      "type": "object",
      "description": "A map's preview: the picture and the facts the map service gives, or why there is none."
    },
    "MapPreviewSourceResponse": {
      "properties": {
        "available": {
          "type": "boolean",
          "description": "True when previews are set up on this RustSC. They may still be unavailable at a given moment."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "Who the previews come from, shown beside each one; absent when previews are not set up."
        },
        "url": {
          "type": [
            "null",
            "string"
          ],
          "description": "The service's home page, linked from the name."
        }
      },
      "required": [
        "available"
      ],
      "type": "object"
    },
    "MapSizeResponse": {
      "properties": {
        "default": {
          "format": "int32",
          "type": "integer",
          "description": "The size Add server starts with."
        },
        "maximum": {
          "format": "int32",
          "type": "integer"
        },
        "minimum": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "minimum",
        "maximum",
        "default"
      ],
      "type": "object"
    },
    "MarketingPreferenceResponse": {
      "properties": {
        "changedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the choice was last set, or null when it never was."
        },
        "optedIn": {
          "type": "boolean",
          "description": "True when the account gets product updates and news by email. False when it turned them off, or when nothing was ever recorded for it (an account made before the sign-up step existed)."
        }
      },
      "required": [
        "optedIn",
        "changedAt"
      ],
      "type": "object",
      "description": "Whether the account gets product updates and news by email."
    },
    "MemberListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/MemberResponse"
          },
          "type": "array",
          "description": "Members ordered by membership ID."
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "Always null: the list is returned in one page."
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The number of items."
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount"
      ],
      "type": "object",
      "description": "Active members of the workspace, in one page."
    },
    "MemberNotificationResponse": {
      "properties": {
        "alerts": {
          "items": {
            "$ref": "#/$defs/NotificationAlertResponse"
          },
          "type": "array"
        },
        "bounds": {
          "$ref": "#/$defs/NotificationBoundsResponse"
        },
        "canManageTemplates": {
          "type": "boolean",
          "description": "Whether the caller may make, change and remove templates (`alerts.settings.manage`, the Owner)."
        },
        "follows": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/NotificationFollowResponse"
            }
          ]
        },
        "note": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/NotificationNoteResponse"
            }
          ]
        },
        "phoneSignedOut": {
          "type": "boolean",
          "description": "True when you take alerts on a phone and no phone of yours is signed in, so none reach it. False otherwise, and while you take none."
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "0 while the member has never saved (nothing is sent to their own devices)."
        },
        "templates": {
          "items": {
            "$ref": "#/$defs/NotificationTemplateResponse"
          },
          "type": "array"
        },
        "timeDisplay": {
          "type": "string",
          "description": "\"Show times in\": `own` (each time in its own zone) or `mine` (times in `timeZone`)."
        },
        "timeZone": {
          "type": "string",
          "description": "The time zone quiet hours are counted in; always the member's own, never a template's."
        },
        "values": {
          "$ref": "#/$defs/NotificationValuesResponse"
        }
      },
      "required": [
        "revision",
        "values",
        "timeZone",
        "timeDisplay",
        "follows",
        "note",
        "canManageTemplates",
        "alerts",
        "templates",
        "bounds"
      ],
      "type": "object",
      "description": "A member's own notification settings with the templates they may adopt."
    },
    "MemberNotificationSaveBody": {
      "properties": {
        "revision": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The revision that was read; a save on an older one is refused with `settings_changed`."
        },
        "timeDisplay": {
          "type": [
            "null",
            "string"
          ],
          "description": "\"Show times in\": `own` shows each time in its own zone (the schedule's or the server's), `mine` shows times in `timeZone`; left out keeps the current choice."
        },
        "timeZone": {
          "type": [
            "null",
            "string"
          ],
          "description": "The time zone quiet hours are counted in (for example `Europe/London`); left out keeps the current one."
        },
        "values": {
          "$ref": "#/$defs/NotificationValuesBody"
        }
      },
      "required": [
        "values"
      ],
      "type": "object",
      "description": "Saves the caller's own notification settings."
    },
    "MemberResponse": {
      "properties": {
        "accountId": {
          "type": "string",
          "description": "The member's account ID."
        },
        "chatName": {
          "type": "string",
          "description": "The name the member's chat messages go out under in this workspace: the one they chose, otherwise their Discord display name, otherwise \"Staff\". The workspace's other members see it."
        },
        "chatNameClash": {
          "type": [
            "null",
            "string"
          ],
          "description": "The chat name of another member of this workspace who goes out under the same name (compared without regard to case or the number of spaces), else null. Set only on the member list. It is for a marker that tells an administrator two people read the same in chat; nothing is renamed behind anyone's back."
        },
        "email": {
          "type": [
            "null",
            "string"
          ],
          "description": "The email address the member signs in with. Null only when the account no longer exists."
        },
        "id": {
          "type": "string",
          "description": "Membership ID."
        },
        "roles": {
          "items": {
            "$ref": "#/$defs/RoleAssignmentResponse"
          },
          "type": "array",
          "description": "Role assignments with their scopes."
        }
      },
      "required": [
        "id",
        "accountId",
        "email",
        "chatName",
        "roles"
      ],
      "type": "object",
      "description": "An active member of the workspace and the roles assigned to it."
    },
    "MembershipResponse": {
      "properties": {
        "hostPermissions": {
          "items": {
            "$ref": "#/$defs/HostPermissionsResponse"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Only on the single read of a workspace. For each host the caller was given directly (a member limited to some hosts), the permissions\nheld on it, which is reading it. A host that is not listed has the workspace-wide permissions; a host the caller cannot read is never\nlisted, and a caller who reads every host has none listed. The API still checks every request."
        },
        "id": {
          "type": "string",
          "description": "Membership ID, for example `mem_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "permissions": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Permission names held at workspace scope, from the permission catalog. Build navigation from these, never from role names."
        },
        "serverPermissions": {
          "items": {
            "$ref": "#/$defs/ServerPermissionsResponse"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Only on the single read of a workspace. For each server the caller can read and whose permissions differ from\n`permissions` (a server limited grant, or a group grant that covers it), the permissions held on that server:\nthe workspace-wide, group and server grants together. A server that is not listed has the workspace-wide permissions; a\nserver the caller cannot read is never listed. Absent on lists and on creation. The API still checks every request."
        }
      },
      "required": [
        "id",
        "permissions"
      ],
      "type": "object",
      "description": "The caller's membership and what it allows at workspace scope and, where it differs, on single servers."
    },
    "MessagePlayerRequestBody": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the player, only so the activity line says it; optional, up to 64 characters."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID of the player, 17 digits. A name never selects a player."
        },
        "text": {
          "type": "string",
          "description": "The message, 1 to 200 characters. It is shown to the player in their game chat."
        }
      },
      "required": [
        "steamId",
        "text"
      ],
      "type": "object",
      "description": "Sends one private message to one connected player."
    },
    "MessageTemplatePreviewRequestBody": {
      "properties": {
        "context": {
          "type": [
            "null",
            "string"
          ]
        },
        "template": {
          "type": [
            "null",
            "string"
          ]
        },
        "unknownText": {
          "type": [
            "null",
            "string"
          ]
        },
        "values": {
          "additionalProperties": {
            "$ref": "#/$defs/TemplateValueBody"
          },
          "type": [
            "null",
            "object"
          ]
        }
      },
      "type": "object",
      "description": "A template to render without delivering it. `context` is `game_chat`,\n`restart_warning`, `discord_presence`, `discord_message` or\n`notification_text`. Without `values` the documented sample values are used; with\nthem, only those values are used and every other variable renders as unknown. `unknownText` replaces the word `unknown`."
    },
    "MessageTemplatePreviewResponse": {
      "properties": {
        "context": {
          "type": "string"
        },
        "length": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Characters of `output`."
        },
        "maxLength": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The context's bound on `output`, in characters."
        },
        "output": {
          "type": [
            "null",
            "string"
          ]
        },
        "reason": {
          "type": [
            "null",
            "string"
          ]
        },
        "supportedVariables": {
          "items": {
            "$ref": "#/$defs/SupportedVariableResponse"
          },
          "type": "array"
        },
        "template": {
          "type": "string",
          "description": "The template as it would be saved: line endings normalized, trimmed."
        },
        "valueSource": {
          "type": "string",
          "description": "`sample` or `supplied`."
        },
        "variables": {
          "items": {
            "$ref": "#/$defs/PreviewVariableResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "context",
        "template",
        "output",
        "reason",
        "length",
        "maxLength",
        "valueSource",
        "variables",
        "supportedVariables"
      ],
      "type": "object",
      "description": "The rendered text, never delivered. `output` is exactly what the context would send for\nthese values, or null with `reason` `output_too_long`, `required` (nothing\nleft to send) or `limit_not_set` (the context's bound has no register value yet)."
    },
    "MobileAlertChoiceBody": {
      "properties": {
        "on": {
          "type": "boolean",
          "description": "True to take the alert on this phone, false to never take it. To hand the alert back to the member's own choice, DELETE it instead."
        }
      },
      "required": [
        "on"
      ],
      "type": "object",
      "description": "Switches one alert on or off for this phone only."
    },
    "MobileAlertChoiceResponse": {
      "properties": {
        "group": {
          "type": "string",
          "description": "The subgroup: `servers`, `computers`, `backups`, `work`, `players` or `discord`."
        },
        "kind": {
          "type": "string",
          "description": "The alert's key, as in the alert manager."
        },
        "on": {
          "type": "boolean",
          "description": "Whether this phone takes the alert now."
        },
        "own": {
          "type": "boolean",
          "description": "True when this phone has its own choice for the alert; false when it follows the member's own phone choice (the alert has no reset then)."
        },
        "section": {
          "type": "string",
          "description": "`events` or `ongoing`."
        }
      },
      "required": [
        "kind",
        "group",
        "section",
        "on",
        "own"
      ],
      "type": "object",
      "description": "One alert in the phone's own list."
    },
    "MobileAlertChoicesResponse": {
      "properties": {
        "alerts": {
          "items": {
            "$ref": "#/$defs/MobileAlertChoiceResponse"
          },
          "type": "array"
        },
        "chosen": {
          "type": "boolean",
          "description": "False while the workspace has not chosen its alerts: none are sent, so none are listed."
        },
        "deviceId": {
          "type": "string"
        }
      },
      "required": [
        "deviceId",
        "chosen",
        "alerts"
      ],
      "type": "object",
      "description": "The alerts this phone can take and what it does with each. Only this phone is changed by a choice here."
    },
    "MobileInboxAcknowledgementResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": "string"
        },
        "byName": {
          "type": [
            "null",
            "string"
          ]
        },
        "comment": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "at",
        "byName",
        "comment"
      ],
      "type": "object",
      "description": "An acknowledgement: `byName` is the member's name in sentences, absent when it is not known (the portal then says \"Another member\"). `comment` is absent when none was left."
    },
    "MobileInboxComputerResponse": {
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object",
      "description": "The host an alert is about, by name (never an address or an installation)."
    },
    "MobileInboxItemResponse": {
      "properties": {
        "acknowledgement": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/MobileInboxAcknowledgementResponse",
              "description": "Who acknowledged this alert, when and what they wrote. Present only while the alert is acknowledged."
            }
          ]
        },
        "canAcknowledge": {
          "type": "boolean"
        },
        "category": {
          "type": "string"
        },
        "clearedReason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why a cleared alert ended: `recovered`, `next_success`, `dismissed`, `no_longer_applies` or `one_off`. Absent while the alert is going, and on one that ended before the reason was kept."
        },
        "computer": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/MobileInboxComputerResponse",
              "description": "The host (`host_` ID and name) of a host alert when the member may read that host; absent for a server alert."
            }
          ]
        },
        "historyAvailableFrom": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "incidentId": {
          "format": "uuid",
          "type": "string"
        },
        "nextStep": {
          "type": [
            "null",
            "string"
          ]
        },
        "read": {
          "type": "boolean"
        },
        "readAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "reportId": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a new F7 report alert, the report it is about (`rep_` ID), so the app can open it. Absent for every other alert."
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "rule": {
          "type": "string"
        },
        "servers": {
          "items": {
            "$ref": "#/$defs/MobileInboxServerResponse"
          },
          "type": "array"
        },
        "severity": {
          "type": "string"
        },
        "since": {
          "format": "date-time",
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "steamId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The Steam ID of the player the alert is about (a join, leave, kick, ban, chat word, Discord link or the accused player of a report), only for a member who holds `players.moderate` for what the\nalert is about, so the alert's detail can offer it for copying. Absent for everyone else and for every alert that is not about a player. A sentence of the alert never carries it."
        },
        "subject": {
          "type": "string",
          "description": "What the alert is about: `server`, `computer` or `workspace` (a player linked or unlinked their Discord account). A host or workspace alert may have no server on it, so IReadOnlyList&lt;MobileInboxServerResponse&gt; MobileInboxItemResponse.Servers can be empty."
        },
        "summary": {
          "type": [
            "null",
            "string"
          ]
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "subject",
        "incidentId",
        "category",
        "severity",
        "state",
        "rule",
        "revision",
        "since",
        "updatedAt",
        "read",
        "canAcknowledge",
        "readAt",
        "servers"
      ],
      "type": "object"
    },
    "MobileInboxMarkAllReadResponse": {
      "properties": {
        "marked": {
          "format": "int64",
          "type": "integer"
        },
        "unread": {
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "marked",
        "unread"
      ],
      "type": "object",
      "description": "What Mark all read did: how many alerts it marked and how many unread ones are left, the number every badge shows."
    },
    "MobileInboxReadBody": {
      "properties": {
        "read": {
          "type": "boolean"
        }
      },
      "required": [
        "read"
      ],
      "type": "object"
    },
    "MobileInboxResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/MobileInboxItemResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "items",
        "nextCursor"
      ],
      "type": "object"
    },
    "MobileInboxServerResponse": {
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "MobileInboxUnreadCountResponse": {
      "properties": {
        "count": {
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "count"
      ],
      "type": "object"
    },
    "MobileIncidentAcknowledgementResponse": {
      "properties": {
        "state": {
          "type": "string"
        }
      },
      "required": [
        "state"
      ],
      "type": "object"
    },
    "MobileIncidentHistoryResponse": {
      "properties": {
        "historyAvailableFrom": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "items": {
          "items": {
            "$ref": "#/$defs/MobileIncidentTransitionResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "items",
        "nextCursor",
        "historyAvailableFrom"
      ],
      "type": "object"
    },
    "MobileIncidentTransitionResponse": {
      "properties": {
        "actorName": {
          "type": [
            "null",
            "string"
          ]
        },
        "at": {
          "format": "date-time",
          "type": "string"
        },
        "comment": {
          "type": [
            "null",
            "string"
          ]
        },
        "id": {
          "format": "uuid",
          "type": "string"
        },
        "kind": {
          "type": [
            "null",
            "string"
          ]
        },
        "state": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "at",
        "state",
        "actorName"
      ],
      "type": "object",
      "description": "One change of an alert. `kind` is `acknowledged` or `acknowledgement_cleared` for the two a member makes (their name and the comment come with it); absent for the\nchanges RustSC makes by itself."
    },
    "MobileNotificationResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/MobileInboxItemResponse"
          },
          "type": "array"
        },
        "notificationId": {
          "format": "uuid",
          "type": "string"
        },
        "workspaceId": {
          "type": "string"
        }
      },
      "required": [
        "workspaceId",
        "notificationId",
        "items"
      ],
      "type": "object"
    },
    "MobilePreferenceBody": {
      "properties": {
        "allServers": {
          "type": "boolean"
        },
        "categories": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "enabled": {
          "type": "boolean"
        },
        "includeSummary": {
          "type": "boolean"
        },
        "serverIds": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "enabled",
        "categories",
        "allServers",
        "serverIds",
        "includeSummary"
      ],
      "type": "object"
    },
    "MobilePreferenceResponse": {
      "properties": {
        "allServers": {
          "type": "boolean"
        },
        "categories": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "deviceId": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "includeSummary": {
          "type": "boolean"
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "serverIds": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "deviceId",
        "revision",
        "enabled",
        "categories",
        "allServers",
        "serverIds",
        "includeSummary"
      ],
      "type": "object"
    },
    "ModCommandFieldBody": {
      "properties": {
        "kind": {
          "type": [
            "null",
            "string"
          ]
        },
        "label": {
          "type": [
            "null",
            "string"
          ],
          "description": "What a moderator sees beside the box."
        },
        "maxLength": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "minLength": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object",
      "description": "One blank of a mod command. `kind` is `text` (letters, numbers, spaces and a few harmless\ncharacters) or `digits` (numbers only, at most 18); `minLength` and `maxLength` bound what a moderator may type."
    },
    "ModCommandListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/ModCommandResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object"
    },
    "ModCommandRequestBody": {
      "properties": {
        "description": {
          "type": [
            "null",
            "string"
          ]
        },
        "enabled": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Whether moderators may run it; false when left out."
        },
        "fields": {
          "items": {
            "$ref": "#/$defs/ModCommandFieldBody"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "template": {
          "type": [
            "null",
            "string"
          ],
          "description": "The console line; its first word is the command and each blank is a whole word `{name}`."
        }
      },
      "type": "object",
      "description": "A mod command's definition. Saving it runs nothing."
    },
    "ModCommandResponse": {
      "properties": {
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "description": {
          "type": [
            "null",
            "string"
          ]
        },
        "enabled": {
          "type": "boolean"
        },
        "fields": {
          "items": {
            "$ref": "#/$defs/ModCommandFieldBody"
          },
          "type": "array"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "The current revision; the `ETag` is `\"r&lt;revision&gt;\"`."
        },
        "serverId": {
          "type": "string"
        },
        "template": {
          "type": "string"
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "id",
        "serverId",
        "name",
        "description",
        "template",
        "fields",
        "enabled",
        "revision",
        "createdAt",
        "updatedAt"
      ],
      "type": "object"
    },
    "ModCommandRunResponse": {
      "properties": {
        "actor": {
          "$ref": "#/$defs/OperationActorResponse"
        },
        "admission": {
          "$ref": "#/$defs/OperationAdmissionResponse"
        },
        "assistant": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AuditAssistantResponse",
              "description": "The AI assistant behind the operation, with the role it held and the approval it ran, when the workspace's audit trail says so. Null for\nanything a person, a schedule or a rule started, and on routes that do not look it up. The person it acted for is `actor`."
            }
          ]
        },
        "baseRevisions": {
          "items": {
            "$ref": "#/$defs/OperationBaseRevisionResponse"
          },
          "type": "array"
        },
        "cancellation": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationCancellationResponse"
            }
          ]
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "credential": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationCredentialResponse"
            }
          ]
        },
        "effects": {
          "items": {
            "$ref": "#/$defs/OperationEffectResponse"
          },
          "type": "array"
        },
        "error": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationErrorResponse"
            }
          ]
        },
        "executor": {
          "$ref": "#/$defs/OperationExecutorResponse"
        },
        "finishedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "id": {
          "type": "string"
        },
        "input": {
          "$ref": "#/$defs/JsonElement",
          "description": "The captured input of the kind; secrets appear only as references."
        },
        "kind": {
          "type": "string"
        },
        "locks": {
          "items": {
            "$ref": "#/$defs/OperationLockResponse"
          },
          "type": "array"
        },
        "operationIds": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The operation of each value, in the order typed."
        },
        "origin": {
          "$ref": "#/$defs/OperationOriginResponse"
        },
        "parentId": {
          "type": [
            "null",
            "string"
          ]
        },
        "partial": {
          "type": "boolean"
        },
        "permission": {
          "type": [
            "null",
            "string"
          ]
        },
        "progress": {
          "anyOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/JsonElement"
            }
          ]
        },
        "quiet": {
          "type": "boolean",
          "description": "True for work the caller said it started by itself (a screen that opened or refreshed), not because a person asked. The operations list leaves it out unless\nit failed or its outcome is unknown, or unless its kind is asked for by name."
        },
        "resolution": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResolutionResponse"
            }
          ]
        },
        "result": {
          "anyOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/JsonElement"
            }
          ]
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "The same value as the `ETag`."
        },
        "stages": {
          "items": {
            "$ref": "#/$defs/OperationStageResponse"
          },
          "type": "array"
        },
        "startedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "state": {
          "type": "string",
          "description": "Where the operation is now: `running`, `succeeded`, `failed`, `cancelled`, `outcome_unknown`, or the value before it starts, while it waits to run."
        },
        "stateChangedAt": {
          "format": "date-time",
          "type": "string"
        },
        "summary": {
          "type": "string"
        },
        "target": {
          "$ref": "#/$defs/OperationReferenceResponse"
        },
        "traceId": {
          "type": [
            "null",
            "string"
          ]
        },
        "uncertainty": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationUncertaintyResponse"
            }
          ]
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        },
        "via": {
          "type": "string"
        },
        "workspaceId": {
          "type": "string"
        }
      },
      "required": [
        "operationIds"
      ],
      "type": "object",
      "description": "One run: the values typed, one per blank, as text."
    },
    "ModCommandRunnableListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/ModCommandRunnableResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object"
    },
    "ModCommandRunnableResponse": {
      "properties": {
        "description": {
          "type": [
            "null",
            "string"
          ]
        },
        "fields": {
          "items": {
            "$ref": "#/$defs/ModCommandFieldBody"
          },
          "type": "array"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "serverId": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "serverId",
        "name",
        "description",
        "fields",
        "revision"
      ],
      "type": "object",
      "description": "A mod command as a moderator sees it: never the console line."
    },
    "ModeratePlayersRequestBody": {
      "properties": {
        "action": {
          "type": "string",
          "description": "What to do to every player: kick, ban, unban, mute or unmute."
        },
        "expiresInSeconds": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "A ban only: how long it lasts, in seconds from now (60 to 31536000). Left out, the ban never ends."
        },
        "players": {
          "items": {
            "$ref": "#/$defs/BulkPlayerBody"
          },
          "type": "array",
          "description": "One to 20 players. The same Steam ID twice is one line. The lines are sent in this order."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "A kick or a ban: why; optional, up to 200 characters."
        }
      },
      "required": [
        "action",
        "players"
      ],
      "type": "object",
      "description": "Kicks, bans, unbans, mutes or unmutes several players of a rented server in one operation."
    },
    "MuteChatRequestBody": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the member saw, for the activity line only; optional."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID of the player, 17 digits. A name never selects a player."
        }
      },
      "required": [
        "steamId"
      ],
      "type": "object",
      "description": "Mutes or unmutes the chat of one connected player of a rented server through the game's own command: the Steam ID and, for the activity line, the name the member saw."
    },
    "MutePlayerRequestBody": {
      "properties": {
        "minutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How long the mute lasts, in whole minutes: 1 to 10080, 60 when left out."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the player, only so the activity line says it; optional, up to 64 characters."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "The reason the player is told, up to 120 characters; optional."
        },
        "scope": {
          "type": [
            "null",
            "string"
          ],
          "description": "text (the default) or voice."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID of the player, 17 digits. A name never selects a player."
        }
      },
      "required": [
        "steamId"
      ],
      "type": "object",
      "description": "Mutes a player's chat or voice for a while."
    },
    "NextOccurrenceResponse": {
      "properties": {
        "dueAt": {
          "format": "date-time",
          "type": "string",
          "description": "The intended action time (UTC)."
        },
        "dueAtLocal": {
          "type": "string",
          "description": "Display only: the same instant with the schedule zone's offset, RFC 3339."
        },
        "id": {
          "type": "string",
          "description": "The occurrence ID the executor derives for it, `occ_...`."
        },
        "startAt": {
          "format": "date-time",
          "type": "string",
          "description": "The warning start (UTC); equal to DateTime NextOccurrenceResponse.DueAt with no lead."
        }
      },
      "required": [
        "id",
        "dueAt",
        "dueAtLocal",
        "startAt"
      ],
      "type": "object",
      "description": "The next occurrence of a schedule."
    },
    "NexusNetworkBody": {
      "properties": {
        "endpoint": {
          "type": [
            "null",
            "string"
          ],
          "description": "The address of the Nexus service (`nexus.endpoint`), an `http` or `https` address. Empty or absent: the game's own address."
        },
        "hideFullIslands": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Hide islands that are known to be full (`nexus.hidefullislands`). Absent is false, which leaves the setting unset."
        },
        "islandSpawnDistance": {
          "type": [
            "null",
            "string"
          ],
          "description": "How far away islands spawn, as a factor of the map size (`nexus.islandspawndistance`), as decimal text such as `1.5`. Empty or absent: the game's own value."
        },
        "key": {
          "type": [
            "null",
            "string"
          ],
          "description": "The shared secret key of the Nexus (`nexus.secretkey`); every server of one Nexus uses the same key. Required."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "What the member calls the network, for example `Main cluster`. Required, unique in the workspace ignoring case, up to `nameMaxLength` characters."
        }
      },
      "type": "object",
      "description": "The values of a Nexus network a member saves: the name they give it and the four game settings. A server that uses the network gets `nexus.endpoint`, `nexus.secretkey`,\n`nexus.islandspawndistance` and `nexus.hidefullislands` from it."
    },
    "NexusNetworkResponse": {
      "properties": {
        "endpoint": {
          "type": [
            "null",
            "string"
          ],
          "description": "The address, or null for the game's own."
        },
        "hideFullIslands": {
          "type": "boolean"
        },
        "id": {
          "type": "string",
          "description": "The network's ID (`nxn_...`). A server uses it by saving it as `rustsc.nexus_network` in its configuration."
        },
        "islandSpawnDistance": {
          "type": [
            "null",
            "string"
          ],
          "description": "The island distance as decimal text, or null for the game's own value."
        },
        "key": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "usedBy": {
          "format": "int32",
          "type": "integer",
          "description": "How many servers use the network now. Editing it saves a new configuration revision on each of them."
        }
      },
      "required": [
        "id",
        "name",
        "endpoint",
        "key",
        "islandSpawnDistance",
        "hideFullIslands",
        "usedBy"
      ],
      "type": "object",
      "description": "A saved Nexus network."
    },
    "NexusNetworksResponse": {
      "properties": {
        "maxNetworks": {
          "format": "int32",
          "type": "integer",
          "description": "The most networks a workspace can save."
        },
        "nameMaxLength": {
          "format": "int32",
          "type": "integer",
          "description": "The longest network name, in characters."
        },
        "networks": {
          "items": {
            "$ref": "#/$defs/NexusNetworkResponse"
          },
          "type": "array"
        },
        "textMaxLength": {
          "format": "int32",
          "type": "integer",
          "description": "The longest address and the longest key, in characters."
        }
      },
      "required": [
        "networks",
        "maxNetworks",
        "nameMaxLength",
        "textMaxLength"
      ],
      "type": "object",
      "description": "The workspace's saved Nexus networks, by name A to Z, and the limits a save is checked against."
    },
    "NotificationAlertResponse": {
      "properties": {
        "group": {
          "type": "string"
        },
        "kind": {
          "type": "string",
          "description": "The alert's key, as in the alert manager."
        },
        "section": {
          "type": "string",
          "description": "`events` or `ongoing`."
        }
      },
      "required": [
        "kind",
        "group",
        "section"
      ],
      "type": "object",
      "description": "An alert a member can choose to be told about on their own devices."
    },
    "NotificationBoundsResponse": {
      "properties": {
        "maxNameLength": {
          "format": "int32",
          "type": "integer"
        },
        "maxTemplates": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "maxTemplates",
        "maxNameLength"
      ],
      "type": "object"
    },
    "NotificationDeviceBody": {
      "properties": {
        "apnsEnvironment": {
          "type": [
            "null",
            "string"
          ],
          "description": "Apple aps-environment of the signed binary; omitted by Android and older clients."
        },
        "appVersion": {
          "type": "string"
        },
        "generation": {
          "format": "int64",
          "type": "integer"
        },
        "installationId": {
          "format": "uuid",
          "type": "string"
        },
        "locale": {
          "type": "string"
        },
        "permission": {
          "type": "string"
        },
        "token": {
          "type": [
            "null",
            "string"
          ]
        },
        "urgentChannel": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True when an Android phone made the channel for critical alerts; omitted by iPhones and older clients."
        }
      },
      "type": "object",
      "description": "Current native installation state. The token is never returned."
    },
    "NotificationDeviceResponse": {
      "properties": {
        "appId": {
          "type": "string"
        },
        "environment": {
          "type": "string"
        },
        "expiresAt": {
          "format": "date-time",
          "type": "string"
        },
        "generation": {
          "format": "int64",
          "type": "integer"
        },
        "hasToken": {
          "type": "boolean"
        },
        "id": {
          "type": "string"
        },
        "installationId": {
          "format": "uuid",
          "type": "string"
        },
        "permission": {
          "type": "string"
        },
        "platform": {
          "type": "string"
        },
        "registeredAt": {
          "format": "date-time",
          "type": "string"
        },
        "retired": {
          "type": "boolean"
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "tokenVersion": {
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "id",
        "installationId",
        "platform",
        "environment",
        "appId",
        "permission",
        "hasToken",
        "generation",
        "tokenVersion",
        "revision",
        "registeredAt",
        "expiresAt",
        "retired"
      ],
      "type": "object"
    },
    "NotificationFollowResponse": {
      "properties": {
        "templateId": {
          "type": "string"
        },
        "templateName": {
          "type": "string"
        },
        "version": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "templateId",
        "templateName",
        "version"
      ],
      "type": "object",
      "description": "The template a member follows."
    },
    "NotificationLogAlertResponse": {
      "properties": {
        "event": {
          "type": "string",
          "description": "`opened`, `reminder`, `recovered` or `flapping`: what happened to the alert."
        },
        "kind": {
          "type": "string",
          "description": "The alert's key, as in the alert manager."
        },
        "targetId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The server (`srv_`) or host (`host_`) it is about; null for the workspace."
        },
        "targetName": {
          "type": [
            "null",
            "string"
          ]
        },
        "targetType": {
          "type": "string",
          "description": "`server`, `host` or `workspace`."
        }
      },
      "required": [
        "kind",
        "event",
        "targetType",
        "targetId",
        "targetName"
      ],
      "type": "object",
      "description": "An alert a notification is tied to."
    },
    "NotificationLogEntryResponse": {
      "properties": {
        "alerts": {
          "items": {
            "$ref": "#/$defs/NotificationLogAlertResponse"
          },
          "type": "array"
        },
        "at": {
          "format": "date-time",
          "type": "string",
          "description": "When it was sent, or made while it has not been sent."
        },
        "channel": {
          "type": "string",
          "description": "`discord`, `webhook`, `browser` or `phone`."
        },
        "detail": {
          "type": [
            "null",
            "string"
          ],
          "description": "The webhook's name, the browser's name, or the Discord channel's name; null for a phone. Never a link or a key."
        },
        "id": {
          "type": "string"
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `failed` and `skipped`, a stable word for why: `muted_by_you`, `quiet_hours`, `route_off`, `destination_not_configured` and others. A word you do not know is a newer reason."
        },
        "recipientName": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a member's own browser or phone, the member's name as the workspace shows it; null for a place the workspace shares."
        },
        "status": {
          "type": "string",
          "description": "`waiting`, `sent`, `failed`, `skipped` or `unsure` (the post may have arrived; it is never repeated)."
        },
        "text": {
          "type": "string",
          "description": "The words of the notification without formatting."
        },
        "toYou": {
          "type": "boolean",
          "description": "Whether it was addressed to the person reading."
        }
      },
      "required": [
        "id",
        "at",
        "status",
        "reason",
        "channel",
        "detail",
        "recipientName",
        "toYou",
        "text",
        "alerts"
      ],
      "type": "object",
      "description": "One notification of the log."
    },
    "NotificationLogResponse": {
      "properties": {
        "days": {
          "format": "int32",
          "type": "integer",
          "description": "How many days back the log reaches (notifications are kept 90 days)."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/NotificationLogEntryResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "Send as `cursor` for the next page; null on the last page."
        },
        "seesAll": {
          "type": "boolean",
          "description": "True for an owner, who reads every notification of the workspace; any other member reads their own."
        }
      },
      "required": [
        "items",
        "nextCursor",
        "seesAll",
        "days"
      ],
      "type": "object",
      "description": "A page of the notifications log, newest first."
    },
    "NotificationNoteResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": "string"
        },
        "kind": {
          "type": "string",
          "description": "`updated` (the template they follow changed) or `removed` (it was removed; they keep their values and stop following)."
        },
        "templateName": {
          "type": "string"
        }
      },
      "required": [
        "kind",
        "templateName",
        "at"
      ],
      "type": "object",
      "description": "The short note after a change the member did not make."
    },
    "NotificationTemplateAdoptBody": {
      "properties": {
        "follow": {
          "type": "boolean",
          "description": "False copies the values once; true keeps the member's settings equal to the template's until they stop following."
        },
        "templateId": {
          "type": "string",
          "description": "The template's ID (`ntp_`)."
        },
        "version": {
          "format": "int32",
          "type": "integer",
          "description": "The template's version that was looked at; a different one is refused with `template_changed`."
        }
      },
      "required": [
        "templateId",
        "follow",
        "version"
      ],
      "type": "object",
      "description": "Adopts a notification template."
    },
    "NotificationTemplateChangeBody": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "values": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/NotificationValuesBody"
            }
          ]
        }
      },
      "type": "object",
      "description": "Renames a notification template and/or replaces its values. New values raise the version and change every member who follows it."
    },
    "NotificationTemplateCreateBody": {
      "properties": {
        "name": {
          "type": "string"
        },
        "values": {
          "$ref": "#/$defs/NotificationValuesBody"
        }
      },
      "required": [
        "name",
        "values"
      ],
      "type": "object",
      "description": "Makes a notification template."
    },
    "NotificationTemplateResponse": {
      "properties": {
        "followers": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many members follow it; only an owner is told, otherwise null."
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "values": {
          "$ref": "#/$defs/NotificationValuesResponse"
        },
        "version": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "id",
        "name",
        "version",
        "values",
        "followers"
      ],
      "type": "object",
      "description": "A notification template an owner made."
    },
    "NotificationValuesBody": {
      "properties": {
        "browserAlerts": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The alerts (their keys, as in the alert manager) sent to the member's own browsers. Empty means none."
        },
        "phoneAlerts": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The alerts (their keys) sent to the member's own phones. Empty means none."
        },
        "quiet": {
          "$ref": "#/$defs/QuietHoursBody"
        }
      },
      "required": [
        "browserAlerts",
        "phoneAlerts",
        "quiet"
      ],
      "type": "object",
      "description": "What a member's own notification settings, and a notification template, carry."
    },
    "NotificationValuesResponse": {
      "properties": {
        "browserAlerts": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The alerts sent to the member's own browsers (\"Tell me\" by browser). Empty until the member chooses."
        },
        "phoneAlerts": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The alerts sent to the member's own phones (\"Tell me\" by phone). Empty until the member chooses."
        },
        "quiet": {
          "$ref": "#/$defs/QuietHoursResponse"
        }
      },
      "required": [
        "browserAlerts",
        "phoneAlerts",
        "quiet"
      ],
      "type": "object"
    },
    "Observation": {
      "properties": {
        "freshness": {
          "enum": [
            "fresh",
            "stale",
            "unknown"
          ],
          "description": "Freshness of an Observation."
        },
        "observedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the source sampled it, UTC; null when never observed."
        },
        "reason": {
          "enum": [
            "expired",
            "disconnected",
            "not_observed",
            "unsupported",
            "collection_failed",
            null
          ]
        },
        "staleAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When it becomes stale; null when unknown."
        },
        "value": {
          "format": "double",
          "type": [
            "null",
            "number"
          ],
          "description": "The observed value; null exactly when freshness is `unknown`."
        }
      },
      "required": [
        "value",
        "observedAt",
        "staleAt",
        "freshness",
        "reason"
      ],
      "type": "object",
      "description": "A numeric value observed from a server, host or provider, with the time it was observed\nand its freshness, so a missing value is never mistaken for zero."
    },
    "OccurrenceListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/OccurrenceResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "The cursor of the next page; null on the last page."
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Always null."
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount"
      ],
      "type": "object",
      "description": "One page of occurrences, latest intended time first."
    },
    "OccurrenceResponse": {
      "properties": {
        "decidedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the executor decided it, by the executor's clock; null while undecided."
        },
        "dueAt": {
          "format": "date-time",
          "type": "string",
          "description": "The intended action time (UTC)."
        },
        "id": {
          "type": "string"
        },
        "operationId": {
          "type": [
            "null",
            "string"
          ]
        },
        "reportedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the cloud received a host's decision; null for the cloud executor."
        },
        "scheduleRevision": {
          "format": "int64",
          "type": "integer",
          "description": "The schedule revision it was decided under."
        },
        "skipReason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Null otherwise."
        },
        "startAt": {
          "format": "date-time",
          "type": "string"
        },
        "state": {
          "type": "string",
          "description": "Treat unknown values as other."
        }
      },
      "required": [
        "id",
        "scheduleRevision",
        "dueAt",
        "startAt",
        "state",
        "skipReason",
        "operationId",
        "decidedAt",
        "reportedAt"
      ],
      "type": "object",
      "description": "One decided occurrence."
    },
    "OffsiteEntryResponse": {
      "properties": {
        "bytes": {
          "format": "int64",
          "type": "integer",
          "description": "Bytes, before compression; a folder counts everything below it."
        },
        "kind": {
          "type": "string",
          "description": "`folder` or `file`."
        },
        "path": {
          "type": "string",
          "description": "The path below the server's backed-up files."
        }
      },
      "required": [
        "path",
        "bytes",
        "kind"
      ],
      "type": "object",
      "description": "One folder or file the cloud copy would hold."
    },
    "OffsiteResponse": {
      "properties": {
        "backupLimitBytes": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The most bytes one cloud copy of a backup may hold, counted before compression, for this workspace; null when there is no limit. It never applies to backups kept on the server's own host."
        },
        "canManage": {
          "type": "boolean",
          "description": "Whether the caller may turn the switch (`backups.manage`)."
        },
        "connected": {
          "type": "boolean",
          "description": "Whether the server's host has a live connection now."
        },
        "copiesDeletedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "Null while nothing is\nwaiting to be deleted. The portal says it in one sentence with the date."
        },
        "copyCount": {
          "format": "int32",
          "type": "integer",
          "description": "How many cloud copies the list holds."
        },
        "enabled": {
          "type": "boolean",
          "description": "The switch."
        },
        "excludedFolders": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The folders and files the member left out of the cloud copy, as plain paths below the server's backed-up files (`oxide/data/Foo`), up to 50. Empty when nothing is left out. Only the cloud copy is affected; a backup kept on the server's own host is never touched."
        },
        "fileLimitBytes": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The most bytes one file in a cloud copy may have; null when there is no limit."
        },
        "included": {
          "type": "boolean"
        },
        "keepLast": {
          "format": "int32",
          "type": "integer",
          "description": "How many cloud backups are kept, 3 to 100."
        },
        "lastUploadAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the newest upload reached the provider; null before the first."
        },
        "lastUploadBytesAdded": {
          "format": "int64",
          "type": "integer",
          "description": "Bytes the newest upload added to the repository."
        },
        "lastUploadChecked": {
          "type": "boolean",
          "description": "Whether the structure check after the newest upload passed."
        },
        "problem": {
          "type": [
            "null",
            "string"
          ],
          "description": "A stable code of the problem the member should hear about, or null: `unreachable`, `refused`, `wrong_key`, `locked`, `incomplete`,\n`timed_out`, `no_credential` or `failed` (an upload), `provider_unreachable`, `provider_refused`, `key_unreadable` or\n`not_prepared` (the cloud's own preparation), `damaged` (the check of the stored copy), `over_ceiling` (history is kept short to fit the storage allowance), `uploads_paused` (stored data reached ten times the allowance), `too_large` (the copy would be over the size limit, so it was not\nuploaded; the backup on the host is untouched) or `file_too_large` (one file is over the per-file limit)."
        },
        "problemAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "problemBytes": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "With `problem` `too_large` the size counted when the host stopped counting, which is at least `problemLimitBytes` and not the true total; with `file_too_large` the size of the\nlargest file seen. Null for every other problem."
        },
        "problemEntries": {
          "items": {
            "$ref": "#/$defs/OffsiteEntryResponse"
          },
          "type": "array",
          "description": "With `problem` `too_large` or `file_too_large`, the biggest folders and files the copy would hold, largest first (up to 10), as the host saw them after the choice above. A folder counts everything below it. Empty for every other problem or before the host has reported."
        },
        "problemLimitBytes": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "With `too_large` or `file_too_large`, the limit the host refused against; null otherwise."
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "The revision of the setting the host was told; 0 before the first time it was turned on."
        },
        "serverId": {
          "type": "string"
        },
        "state": {
          "type": "string",
          "description": "`off`, `setting_up` (the place, the key escrow or the credential is still being made), `on` (the next backup uploads) or `not_configured` (this cloud has no cloud backup storage set up; supported and included are false and the read still answers 200)."
        },
        "storedBytes": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "Bytes the cloud last measured under the server's folder; null until it has."
        },
        "supported": {
          "type": "boolean",
          "description": "Whether the server's host can make cloud copies: a full host with a host service. A restricted host cannot."
        }
      },
      "required": [
        "serverId",
        "included",
        "supported",
        "enabled",
        "state",
        "keepLast",
        "revision",
        "lastUploadBytesAdded",
        "lastUploadChecked",
        "copyCount",
        "connected",
        "canManage"
      ],
      "type": "object",
      "description": "A server's cloud copy as the Backups tab shows it. No key, credential or\nprovider address is part of it."
    },
    "OffsiteRestorePointResponse": {
      "properties": {
        "bytes": {
          "format": "int64",
          "type": "integer",
          "description": "Bytes of the backup."
        },
        "bytesAdded": {
          "format": "int64",
          "type": "integer",
          "description": "Bytes this copy added to the repository (the rest was already there)."
        },
        "checked": {
          "type": "boolean",
          "description": "Whether the structure check after the upload passed."
        },
        "madeHere": {
          "type": "boolean",
          "description": "Whether the server's host holds this backup's record. False for a copy an earlier host of the server made: the new host gets it with\n`restoreServerOffsiteBackupHere`, and an ordinary fetch would answer `offsite_copy_not_known_here`."
        },
        "recoveryPointId": {
          "type": "string",
          "description": "The local backup it was made from."
        },
        "takenAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the local backup was taken."
        },
        "uploadedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the copy reached the provider."
        }
      },
      "required": [
        "recoveryPointId",
        "takenAt",
        "uploadedAt",
        "bytes",
        "bytesAdded",
        "checked",
        "madeHere"
      ],
      "type": "object",
      "description": "One cloud copy of a local backup."
    },
    "OffsiteRestorePointsResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/OffsiteRestorePointResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object",
      "description": "A server's cloud copies, newest first."
    },
    "OperationActorResponse": {
      "properties": {
        "id": {
          "type": [
            "null",
            "string"
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "type",
        "id",
        "name"
      ],
      "type": "object",
      "description": "`type`: `account`, `schedule`, `rule`, `local`, `support` or `system`; a support actor has no ID and the name \"RustSC support\"."
    },
    "OperationAdmissionResponse": {
      "properties": {
        "ifBusy": {
          "type": "string"
        },
        "ifOffline": {
          "type": "string"
        },
        "notAfter": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "ifBusy",
        "ifOffline",
        "notAfter"
      ],
      "type": "object"
    },
    "OperationBaseRevisionResponse": {
      "properties": {
        "id": {
          "type": "string"
        },
        "resource": {
          "type": "string"
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "resource",
        "id",
        "revision"
      ],
      "type": "object"
    },
    "OperationCancellationResponse": {
      "properties": {
        "reason": {
          "type": "string"
        },
        "requestedAt": {
          "format": "date-time",
          "type": "string"
        },
        "requestedBy": {
          "$ref": "#/$defs/OperationActorResponse"
        },
        "state": {
          "type": "string"
        }
      },
      "required": [
        "requestedAt",
        "requestedBy",
        "reason",
        "state"
      ],
      "type": "object"
    },
    "OperationCredentialResponse": {
      "properties": {
        "clientId": {
          "type": [
            "null",
            "string"
          ]
        },
        "id": {
          "type": [
            "null",
            "string"
          ]
        },
        "type": {
          "type": "string"
        },
        "verifiedClient": {
          "type": [
            "null",
            "boolean"
          ]
        }
      },
      "required": [
        "type",
        "id",
        "clientId",
        "verifiedClient"
      ],
      "type": "object"
    },
    "OperationEffectResponse": {
      "properties": {
        "code": {
          "type": "string"
        },
        "recoveryPointId": {
          "type": [
            "null",
            "string"
          ]
        },
        "resource": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationReferenceResponse"
            }
          ]
        },
        "reversible": {
          "type": "boolean"
        },
        "stage": {
          "type": "string"
        }
      },
      "required": [
        "stage",
        "code",
        "resource",
        "reversible",
        "recoveryPointId"
      ],
      "type": "object",
      "description": "An applied effect; the code carries wording such as \"possibly delivered\" (`announcement_possibly_delivered`)."
    },
    "OperationErrorResponse": {
      "properties": {
        "code": {
          "type": "string"
        },
        "reason": {
          "type": [
            "null",
            "string"
          ]
        },
        "retryable": {
          "type": "boolean"
        },
        "stage": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "code",
        "reason",
        "stage",
        "retryable"
      ],
      "type": "object"
    },
    "OperationExecutorResponse": {
      "properties": {
        "installationId": {
          "type": [
            "null",
            "string"
          ]
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "type",
        "installationId"
      ],
      "type": "object"
    },
    "OperationListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/OperationResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "The cursor of the next page; null on the last page."
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Always null."
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount"
      ],
      "type": "object",
      "description": "One page of operations, newest first."
    },
    "OperationLockResponse": {
      "properties": {
        "id": {
          "type": "string"
        },
        "mode": {
          "type": "string"
        },
        "resource": {
          "type": "string"
        },
        "state": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "resource",
        "id",
        "mode",
        "state"
      ],
      "type": "object",
      "description": "A lock the kind declares; `state` (`waiting`, `held`, `released`) is null where this route does not read it."
    },
    "OperationOriginResponse": {
      "properties": {
        "occurrenceId": {
          "type": [
            "null",
            "string"
          ]
        },
        "planId": {
          "type": [
            "null",
            "string"
          ]
        },
        "retryOfId": {
          "type": [
            "null",
            "string"
          ]
        },
        "ruleRunId": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "planId",
        "occurrenceId",
        "ruleRunId",
        "retryOfId"
      ],
      "type": "object"
    },
    "OperationReferenceResponse": {
      "properties": {
        "id": {
          "type": [
            "null",
            "string"
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "type",
        "id",
        "name"
      ],
      "type": "object",
      "description": "A target or effect resource; `name` is null when the route does not resolve it."
    },
    "OperationResolutionResponse": {
      "properties": {
        "laterEvidence": {
          "type": "array"
        },
        "method": {
          "type": "string"
        },
        "observed": {
          "type": [
            "null",
            "string"
          ]
        },
        "outcome": {
          "type": "string"
        },
        "reason": {
          "type": [
            "null",
            "string"
          ]
        },
        "resolvedAt": {
          "format": "date-time",
          "type": "string"
        },
        "resolvedBy": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationActorResponse"
            }
          ]
        }
      },
      "required": [
        "method",
        "outcome",
        "reason",
        "observed",
        "resolvedBy",
        "resolvedAt",
        "laterEvidence"
      ],
      "type": "object"
    },
    "OperationResponse": {
      "properties": {
        "actor": {
          "$ref": "#/$defs/OperationActorResponse"
        },
        "admission": {
          "$ref": "#/$defs/OperationAdmissionResponse"
        },
        "assistant": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AuditAssistantResponse",
              "description": "The AI assistant behind the operation, with the role it held and the approval it ran, when the workspace's audit trail says so. Null for\nanything a person, a schedule or a rule started, and on routes that do not look it up. The person it acted for is `actor`."
            }
          ]
        },
        "baseRevisions": {
          "items": {
            "$ref": "#/$defs/OperationBaseRevisionResponse"
          },
          "type": "array"
        },
        "cancellation": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationCancellationResponse"
            }
          ]
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "credential": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationCredentialResponse"
            }
          ]
        },
        "effects": {
          "items": {
            "$ref": "#/$defs/OperationEffectResponse"
          },
          "type": "array"
        },
        "error": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationErrorResponse"
            }
          ]
        },
        "executor": {
          "$ref": "#/$defs/OperationExecutorResponse"
        },
        "finishedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "id": {
          "type": "string"
        },
        "input": {
          "$ref": "#/$defs/JsonElement",
          "description": "The captured input of the kind; secrets appear only as references."
        },
        "kind": {
          "type": "string"
        },
        "locks": {
          "items": {
            "$ref": "#/$defs/OperationLockResponse"
          },
          "type": "array"
        },
        "origin": {
          "$ref": "#/$defs/OperationOriginResponse"
        },
        "parentId": {
          "type": [
            "null",
            "string"
          ]
        },
        "partial": {
          "type": "boolean"
        },
        "permission": {
          "type": [
            "null",
            "string"
          ]
        },
        "progress": {
          "anyOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/JsonElement"
            }
          ]
        },
        "quiet": {
          "type": "boolean",
          "description": "True for work the caller said it started by itself (a screen that opened or refreshed), not because a person asked. The operations list leaves it out unless\nit failed or its outcome is unknown, or unless its kind is asked for by name."
        },
        "resolution": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResolutionResponse"
            }
          ]
        },
        "result": {
          "anyOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/JsonElement"
            }
          ]
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "The same value as the `ETag`."
        },
        "stages": {
          "items": {
            "$ref": "#/$defs/OperationStageResponse"
          },
          "type": "array"
        },
        "startedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "state": {
          "type": "string",
          "description": "Where the operation is now: `running`, `succeeded`, `failed`, `cancelled`, `outcome_unknown`, or the value before it starts, while it waits to run."
        },
        "stateChangedAt": {
          "format": "date-time",
          "type": "string"
        },
        "summary": {
          "type": "string"
        },
        "target": {
          "$ref": "#/$defs/OperationReferenceResponse"
        },
        "traceId": {
          "type": [
            "null",
            "string"
          ]
        },
        "uncertainty": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationUncertaintyResponse"
            }
          ]
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        },
        "via": {
          "type": "string"
        },
        "workspaceId": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "workspaceId",
        "kind",
        "summary",
        "target",
        "parentId",
        "origin",
        "actor",
        "credential",
        "via",
        "permission",
        "executor",
        "admission",
        "input",
        "baseRevisions",
        "locks",
        "state",
        "partial",
        "stages",
        "progress",
        "result",
        "effects",
        "error",
        "uncertainty",
        "cancellation",
        "resolution",
        "createdAt",
        "startedAt",
        "finishedAt",
        "stateChangedAt",
        "updatedAt",
        "revision",
        "traceId"
      ],
      "type": "object",
      "description": "The operation resource. Every field\nis present; null means none yet or not applicable. Clients treat unknown kinds, states and\ncodes as \"other\"."
    },
    "OperationStageResponse": {
      "properties": {
        "cancel": {
          "type": "string"
        },
        "effectClass": {
          "type": "string"
        },
        "error": {
          "anyOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/JsonElement"
            }
          ]
        },
        "evidence": {
          "anyOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/JsonElement"
            }
          ]
        },
        "finishedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "name": {
          "type": "string"
        },
        "required": {
          "type": "boolean"
        },
        "result": {
          "anyOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/JsonElement"
            }
          ]
        },
        "startedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "state": {
          "type": "string"
        }
      },
      "required": [
        "name",
        "state",
        "required",
        "effectClass",
        "cancel",
        "startedAt",
        "finishedAt",
        "result",
        "error",
        "evidence"
      ],
      "type": "object",
      "description": "One stage. `result` is the stage's own result as its executor reported it; `evidence` is\nthe proof the executor attached to it (for a save, the save result with the server evidence that\nconfirmed it), or null when none was reported."
    },
    "OperationUncertaintyResponse": {
      "properties": {
        "known": {
          "type": [
            "null",
            "string"
          ]
        },
        "reason": {
          "type": "string"
        },
        "since": {
          "format": "date-time",
          "type": "string"
        },
        "stage": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "reason",
        "stage",
        "since",
        "known"
      ],
      "type": "object",
      "description": "`reason`: `result_lost`, `effect_unconfirmed`, `executor_lost`, `executor_record_missing`, `claim_expired` or `host_restarted`."
    },
    "OsUpdatesChoiceResponse": {
      "properties": {
        "aheadOfRestart": {
          "type": "boolean"
        },
        "days": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": "array"
        },
        "delayDays": {
          "format": "int32",
          "type": "integer"
        },
        "include": {
          "type": "string"
        },
        "leadMinutes": {
          "format": "int32",
          "type": "integer"
        },
        "mode": {
          "type": "string"
        },
        "restartBySchedule": {
          "type": "boolean",
          "description": "True when the choice belongs to a \"Restart host\" schedule: the host installs at the time above and that schedule restarts it."
        },
        "restartWindowHours": {
          "format": "int32",
          "type": "integer"
        },
        "takeOverWindowsRestarts": {
          "type": "boolean"
        },
        "time": {
          "type": "string"
        },
        "timeZone": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "mode",
        "days",
        "time",
        "delayDays",
        "aheadOfRestart",
        "leadMinutes",
        "restartWindowHours",
        "include",
        "takeOverWindowsRestarts"
      ],
      "type": "object"
    },
    "OsUpdatesResponse": {
      "properties": {
        "count": {
          "format": "int32",
          "type": "integer",
          "description": "Essential updates waiting that are not installed (security or critical updates that need a restart); 0 unless `state` is `pending`."
        },
        "critical": {
          "type": "boolean",
          "description": "True when at least one of the waiting updates is marked Critical by Microsoft. Only essential updates are counted (security or critical\nupdates that need a restart), so this is shown as one word, \"Critical\", next to the count. False when none is or the host did not say."
        },
        "downloaded": {
          "format": "int32",
          "type": "integer",
          "description": "How many of the waiting updates Windows has already downloaded."
        },
        "observedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the host reported it, UTC."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why the search could not finish: `access_denied`, `timed_out` or `search_failed`; null unless `state` is `unknown`. Treat unknown values as `search_failed`."
        },
        "state": {
          "type": "string",
          "description": "`none` (the search ran and found nothing), `pending` (updates are waiting) or `unknown` (the search could not finish; see\n`reason`). Treat unknown values as unknown."
        }
      },
      "required": [
        "state",
        "count",
        "downloaded",
        "reason",
        "observedAt"
      ],
      "type": "object",
      "description": "The pending operating system updates a host reports (, Level 1; Windows hosts only)."
    },
    "OsUpdatesResultResponse": {
      "properties": {
        "at": {
          "type": "string"
        },
        "failed": {
          "format": "int32",
          "type": "integer"
        },
        "installed": {
          "format": "int32",
          "type": "integer"
        },
        "kind": {
          "type": "string",
          "description": "nothing_waiting, installed_no_restart, installed_restart_planned, installed_and_restarted, failed, partial, search_failed or restart_unavailable."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ]
        },
        "restartAt": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "at",
        "kind",
        "installed",
        "failed"
      ],
      "type": "object",
      "description": "The last result of an update run, as stable codes the portal turns into a sentence."
    },
    "OsUpdatesRunResponse": {
      "properties": {
        "deferredReason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why the run waits, in words a person reads (for example \"A wipe is running.\"); null when it does not."
        },
        "installAt": {
          "type": [
            "null",
            "string"
          ]
        },
        "lastResult": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OsUpdatesResultResponse"
            }
          ]
        },
        "manualRequestId": {
          "type": [
            "null",
            "string"
          ]
        },
        "manualRequestState": {
          "type": [
            "null",
            "string"
          ]
        },
        "manualRequestSupported": {
          "type": "boolean"
        },
        "manualResult": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OsUpdatesResultResponse"
            }
          ]
        },
        "observedAt": {
          "type": "string"
        },
        "phase": {
          "type": "string",
          "description": "idle, waiting, installing, awaiting_restart or restarting."
        },
        "restartAt": {
          "type": [
            "null",
            "string"
          ]
        },
        "serverRestartScheduled": {
          "type": "boolean",
          "description": "Whether a server on the host has a restart schedule; the install ahead of the restart is offered only then."
        },
        "windowsRestartSettings": {
          "type": "string",
          "description": "held, not_held, not_confirmed or unknown: whether Windows' own restart settings are the ones RustSC set."
        }
      },
      "required": [
        "phase",
        "serverRestartScheduled",
        "windowsRestartSettings",
        "observedAt"
      ],
      "type": "object",
      "description": "Where the host's update run stands, from its newest report."
    },
    "OwnedCountRowResponse": {
      "properties": {
        "buildings": {
          "format": "int32",
          "type": "integer",
          "description": "Building blocks and other parts under the building prefabs."
        },
        "deployables": {
          "format": "int32",
          "type": "integer",
          "description": "Every other owned entity."
        },
        "steamId": {
          "type": "string"
        },
        "total": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "steamId",
        "buildings",
        "deployables",
        "total"
      ],
      "type": "object"
    },
    "OwnedCountsResponse": {
      "properties": {
        "at": {
          "type": "string",
          "description": "When the pass ran (the game's clock)."
        },
        "cached": {
          "type": "boolean",
          "description": "True when this is a kept answer and nothing was scanned."
        },
        "generation": {
          "type": "string",
          "description": "The world generation counted; a preview sends it back."
        },
        "players": {
          "items": {
            "$ref": "#/$defs/OwnedCountRowResponse"
          },
          "type": "array",
          "description": "The owners, most entities first."
        },
        "scanMs": {
          "format": "int32",
          "type": "integer",
          "description": "How long the pass took, in milliseconds."
        },
        "scanned": {
          "format": "int32",
          "type": "integer",
          "description": "How many entities the pass looked at."
        },
        "truncated": {
          "type": "boolean",
          "description": "True when more players own something than were listed."
        }
      },
      "required": [
        "generation",
        "at",
        "cached",
        "scanned",
        "scanMs",
        "truncated",
        "players"
      ],
      "type": "object"
    },
    "OwnedPreviewResponse": {
      "properties": {
        "buildings": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "deployables": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "found": {
          "type": "boolean"
        },
        "generation": {
          "type": "string"
        },
        "reason": {
          "type": [
            "null",
            "string"
          ]
        },
        "revision": {
          "type": [
            "null",
            "string"
          ],
          "description": "What the removal must send back; it names exactly the captured set."
        },
        "total": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "windowSeconds": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How long the plugin keeps the captured set, in seconds."
        }
      },
      "required": [
        "found",
        "generation"
      ],
      "type": "object"
    },
    "OwnershipTransferResponse": {
      "properties": {
        "formerOwner": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/MemberResponse",
              "description": "The member who made the transfer, as they are now; null when the caller held no Owner role to give up."
            }
          ]
        },
        "newOwner": {
          "$ref": "#/$defs/MemberResponse",
          "description": "The member who owns the workspace now."
        }
      },
      "required": [
        "newOwner",
        "formerOwner"
      ],
      "type": "object",
      "description": "The result of an ownership transfer: the new Owner and the caller, who is now an Administrator."
    },
    "PanelActionBody": {
      "properties": {
        "command": {
          "type": [
            "null",
            "string"
          ],
          "description": "The console command, one line, for `command`. Never stored with the action and never in the audit record."
        },
        "kind": {
          "type": [
            "null",
            "string"
          ],
          "description": "`start`, `stop`, `restart`, `kill` (ends the game at once without saving, where the host offers it) or `command`."
        }
      },
      "type": "object",
      "description": "What to ask of a connected rented server."
    },
    "PanelActionItemResponse": {
      "properties": {
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "finishedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "id": {
          "type": "string",
          "description": "The action's ID (`pac_...`)."
        },
        "kind": {
          "type": "string"
        },
        "reason": {
          "type": "string",
          "description": "The plain sentence for the state; empty when there is nothing to add."
        },
        "retryAfterSeconds": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "While `waiting`: how long the host asked RustSC to wait, in seconds."
        },
        "state": {
          "type": "string",
          "description": "`queued`, `waiting`, `accepted`, `refused`, `rejected`, `unknown`, `confirmed` or `failed`. Accepted means the host took the request, not that the game is ready."
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        },
        "worldSave": {
          "type": [
            "null",
            "string"
          ],
          "description": "A stop or restart only, on a server whose console commands reach it (owner decision OA92): `saving` while the world is saved first, `not_saved` when the world could not be\nsaved first (the stop or restart still went ahead); null when nothing was asked of the game first or the save went through."
        }
      },
      "required": [
        "id",
        "kind",
        "state",
        "reason",
        "retryAfterSeconds",
        "createdAt",
        "updatedAt",
        "finishedAt"
      ],
      "type": "object",
      "description": "One thing asked of a connected rented server, and where it stands."
    },
    "PanelActionResponse": {
      "properties": {
        "outcome": {
          "type": "string",
          "description": "`accepted`, `refused` (nothing was sent), `rejected` (the host said no) or `unknown` (it may have gone through)."
        },
        "reason": {
          "type": "string",
          "description": "The plain sentence for anything but `accepted`; empty when accepted."
        },
        "retryAfterSeconds": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The wait the host asked for when it was limiting requests, in seconds, or null."
        }
      },
      "required": [
        "outcome",
        "reason",
        "retryAfterSeconds"
      ],
      "type": "object",
      "description": "How one call through the host ended."
    },
    "PanelActionsResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/PanelActionItemResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object",
      "description": "The newest actions of a connected rented server, newest first."
    },
    "PanelCapabilityLineResponse": {
      "properties": {
        "capability": {
          "type": "string",
          "description": "The capability's stable name: `Start`, `Stop`, `Restart`, `Command`, `ReadFiles`, `WriteFiles` or `StartupValues`."
        },
        "label": {
          "type": "string",
          "description": "What it is in plain words, such as `restarting the server`."
        },
        "reason": {
          "type": "string",
          "description": "The plain sentence for anything but `Available`; empty when available."
        },
        "route": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a line that works, the one short phrase that says which route delivers it: `Through` and the host's name, `Through your server's console.` or `Through your file login.`. Absent when the line does not work or the check was made before routes were recorded."
        },
        "routeWhy": {
          "type": [
            "null",
            "string"
          ],
          "description": "Present only when more than one route could deliver the function: the other way or ways, in one short sentence."
        },
        "state": {
          "type": "string",
          "description": "`Available`, `NeedsAccess`, `Unreachable`, `Unsupported` or `NotTested`."
        }
      },
      "required": [
        "capability",
        "label",
        "state",
        "reason"
      ],
      "type": "object",
      "description": "One thing RustSC could do on the host, with the sentence that says why it cannot when it cannot."
    },
    "PanelChangeBody": {
      "properties": {
        "endAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "items": {
          "items": {
            "$ref": "#/$defs/PanelItemBody"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the member knows it by, 1 to 40 characters."
        },
        "startAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object"
    },
    "PanelChangeResponse": {
      "properties": {
        "endAt": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "items": {
          "items": {
            "$ref": "#/$defs/PanelItemResponse"
          },
          "type": "array"
        },
        "line": {
          "type": [
            "null",
            "string"
          ],
          "description": "The last thing that happened to it, in plain words; absent before it started."
        },
        "name": {
          "type": "string"
        },
        "startAt": {
          "format": "date-time",
          "type": "string"
        },
        "state": {
          "type": "string",
          "description": "waiting, active, ended or missed."
        }
      },
      "required": [
        "id",
        "name",
        "startAt",
        "endAt",
        "state",
        "items"
      ],
      "type": "object"
    },
    "PanelCheckResponse": {
      "properties": {
        "askConsole": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True when the host cannot send console commands itself and the server's own console can: the form then asks for the console once, and the member may skip it."
        },
        "canConnect": {
          "type": "boolean",
          "description": "True when at least one thing works, so there is something to connect."
        },
        "consoleFill": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PanelConsoleFillResponse",
              "description": "Present when the host has no way to send console commands and its page shows where the game's console is, for the workspace Owner: the values to fill the console step in with. Nothing is saved by reading them."
            }
          ]
        },
        "host": {
          "type": "string"
        },
        "lines": {
          "items": {
            "$ref": "#/$defs/PanelCapabilityLineResponse"
          },
          "type": "array"
        },
        "setup": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PanelSetupResponse",
              "description": "Check only, when something works: the rest of the form (the server's address and query port, and the console), filled where the host's own API says. Absent on a Connect."
            }
          ]
        },
        "summary": {
          "type": "string",
          "description": "One sentence: what RustSC can do on the host, or that it cannot yet."
        }
      },
      "required": [
        "host",
        "summary",
        "lines",
        "canConnect"
      ],
      "type": "object",
      "description": "What a check found, in words."
    },
    "PanelConnectResponse": {
      "properties": {
        "check": {
          "$ref": "#/$defs/PanelCheckResponse"
        },
        "connection": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PanelConnectionResponse",
              "description": "The connection, or null when nothing works and nothing was saved."
            }
          ]
        }
      },
      "required": [
        "connection",
        "check"
      ],
      "type": "object",
      "description": "The result of connecting: the saved connection when something works, and always the check."
    },
    "PanelConnectionResponse": {
      "properties": {
        "capabilities": {
          "items": {
            "$ref": "#/$defs/PanelCapabilityLineResponse"
          },
          "type": "array",
          "description": "What the member can ask of the server, from the last check: each thing works, or has the plain sentence for why not. Only what works is offered."
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "hostId": {
          "type": "string"
        },
        "hostName": {
          "type": "string"
        },
        "id": {
          "type": "string",
          "description": "The connection's ID (`pcn_...`)."
        },
        "lastCheckedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "layout": {
          "type": [
            "null",
            "string"
          ],
          "description": "On a Beta host: `ready` when changing files works, `checking` while RustSC is still looking at the host's file layout; null on any other host."
        },
        "name": {
          "type": "string"
        },
        "panelHost": {
          "type": [
            "null",
            "string"
          ],
          "description": "The panel's host name for display, or null for a host with a fixed address."
        },
        "serverId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The server's ID (`srv_...`) in the Servers list, where it shows as managed through the host's panel; null for a connection made before servers were registered."
        },
        "summary": {
          "type": [
            "null",
            "string"
          ],
          "description": "The sentence the last check ended with."
        }
      },
      "required": [
        "id",
        "hostId",
        "hostName",
        "name",
        "panelHost",
        "summary",
        "lastCheckedAt",
        "createdAt",
        "serverId",
        "capabilities"
      ],
      "type": "object",
      "description": "A connected rented server. No part of the key is shown."
    },
    "PanelConsoleBody": {
      "properties": {
        "dueAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The first time. Optional with everyMinutes (then one step from now; one that passed starts at its next step); not read with repeat."
        },
        "everyMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Repeats every this many minutes, 1 to 10080."
        },
        "keepLast": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "For a backup: how many scheduled copies to keep, 1 to 14 (7 when left out). The oldest scheduled copy goes after a new one is stored; copies the member took with Back up now are never removed by it."
        },
        "kind": {
          "type": [
            "null",
            "string"
          ],
          "description": "say (a line said in game chat), command (a console command) or backup (a backup of the server's own copy in RustSC's storage)."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the member knows it by, 1 to 40 characters."
        },
        "repeat": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PanelRestartRepeatBody",
              "description": "Repeats at a time of day on chosen days. Not with everyMinutes."
            }
          ]
        },
        "text": {
          "type": [
            "null",
            "string"
          ],
          "description": "The line or the command, up to 500 characters, one line."
        }
      },
      "type": "object"
    },
    "PanelConsoleFillResponse": {
      "properties": {
        "host": {
          "type": "string",
          "description": "The console's address."
        },
        "password": {
          "type": [
            "null",
            "string"
          ],
          "description": "The console password the host shows, when it shows one; absent otherwise."
        },
        "port": {
          "format": "int32",
          "type": "integer",
          "description": "The console's port."
        }
      },
      "required": [
        "host",
        "port"
      ],
      "type": "object",
      "description": "Where the host says the game's console is, to fill the form in. Only the workspace Owner is given it."
    },
    "PanelConsoleListResponse": {
      "properties": {
        "backupOffered": {
          "type": "boolean",
          "description": "True where a saved backup can run (the connection lists and reads files and RustSC's storage is set up); a save of kind backup is refused with not_offered where it is false."
        },
        "hostName": {
          "type": "string"
        },
        "offered": {
          "type": "boolean",
          "description": "False where commands do not reach the server now; a save is then refused with not_offered."
        },
        "onPanelHost": {
          "type": "boolean"
        },
        "schedules": {
          "items": {
            "$ref": "#/$defs/PanelConsoleResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "onPanelHost",
        "hostName",
        "offered",
        "schedules"
      ],
      "type": "object"
    },
    "PanelConsoleResponse": {
      "properties": {
        "dueAt": {
          "format": "date-time",
          "type": "string",
          "description": "The next time; for a done one time schedule, the time it ran."
        },
        "everyMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "id": {
          "type": "string"
        },
        "keepLast": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "For a backup: how many scheduled copies it keeps."
        },
        "kind": {
          "type": "string",
          "description": "say, command or backup."
        },
        "name": {
          "type": "string"
        },
        "recent": {
          "items": {
            "$ref": "#/$defs/PanelConsoleResultResponse"
          },
          "type": "array",
          "description": "The newest results first, a few only."
        },
        "repeat": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PanelRestartRepeatResponse"
            }
          ]
        },
        "state": {
          "type": "string",
          "description": "waiting or done."
        },
        "text": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "kind",
        "name",
        "text",
        "dueAt",
        "state",
        "recent"
      ],
      "type": "object"
    },
    "PanelConsoleResultResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": "string"
        },
        "line": {
          "type": "string",
          "description": "What happened, in plain words."
        },
        "reply": {
          "type": [
            "null",
            "string"
          ],
          "description": "The game's reply to a command, cut; absent when there was none."
        },
        "state": {
          "type": "string",
          "description": "sent, failed, missed or unknown."
        }
      },
      "required": [
        "at",
        "state",
        "line"
      ],
      "type": "object"
    },
    "PanelExecutorResponse": {
      "properties": {
        "changedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the choice was last saved; absent until it was."
        },
        "on": {
          "type": "boolean"
        }
      },
      "required": [
        "on"
      ],
      "type": "object"
    },
    "PanelGlobalBansBody": {
      "properties": {
        "enabled": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True to apply the workspace's global bans to this server, false to take them off. Required."
        }
      },
      "type": "object",
      "description": "The choice to apply the workspace's global bans to one server on a hosting panel (`PUT .../servers/{serverId}/panel-global-bans`)."
    },
    "PanelGlobalBansResponse": {
      "properties": {
        "available": {
          "type": "boolean",
          "description": "True when the server is connected through its host's panel; false for every other server, and nothing else is meaningful then."
        },
        "checkedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When RustSC last looked; null before the first time."
        },
        "enabled": {
          "type": "boolean",
          "description": "The saved choice."
        },
        "remaining": {
          "format": "int32",
          "type": "integer",
          "description": "Lines still to add or take out."
        },
        "state": {
          "type": "string",
          "description": "One of off, current, applying, waiting_for_server, host_refused, host_busy or unreachable."
        },
        "words": {
          "type": "string",
          "description": "The sentence to show: what is happening and the one thing to do."
        }
      },
      "required": [
        "available",
        "enabled",
        "state",
        "remaining",
        "words"
      ],
      "type": "object",
      "description": "Where a server's global bans stand when its host is a hosting panel."
    },
    "PanelHostAllowsLineResponse": {
      "properties": {
        "offered": {
          "type": "boolean"
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "The one sentence that says why the host does not offer it; absent when it does."
        },
        "step": {
          "type": "string"
        }
      },
      "required": [
        "step",
        "offered"
      ],
      "type": "object"
    },
    "PanelHostAllowsResponse": {
      "properties": {
        "hostName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The host's name; absent when the server is not on a panel host."
        },
        "lines": {
          "items": {
            "$ref": "#/$defs/PanelHostAllowsLineResponse"
          },
          "type": "array"
        },
        "needsBackupConfirmation": {
          "type": "boolean",
          "description": "True when the host has no backup RustSC can start, so a wipe asks for one confirmation first."
        },
        "onPanelHost": {
          "type": "boolean"
        },
        "refusal": {
          "type": [
            "null",
            "string"
          ],
          "description": "Set only when wipe plans cannot run on this host at all."
        }
      },
      "required": [
        "onPanelHost",
        "lines",
        "needsBackupConfirmation"
      ],
      "type": "object"
    },
    "PanelHostBody": {
      "properties": {
        "connectionId": {
          "type": [
            "null",
            "string"
          ],
          "description": "Connect only: the saved connection (`pcn_...`) this Connect changes, so its server id, key, name and console are replaced in place."
        },
        "consoleAddress": {
          "type": [
            "null",
            "string"
          ],
          "description": "The game's own console address, `host` or `host:port` (port 28016 when none). Optional on every host; send it with `consolePassword`. Console commands are offered once the check reaches the console, on a host that has no way to send them itself."
        },
        "consoleFromHost": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Connect only: true to use the console password the host's own startup values show. It is read and kept at Connect and never sent back; `consoleAddress` may name the console (the host's own unless the caller is the workspace Owner)."
        },
        "consolePassword": {
          "type": [
            "null",
            "string"
          ],
          "description": "The game's console password that goes with `consoleAddress`. Kept write-only with the connection, never shown again."
        },
        "fileLoginAddress": {
          "type": [
            "null",
            "string"
          ],
          "description": "An optional file login beside the host's key, for files the host cannot handle itself: its address, `host`, `host:port` or with `sftp://`, `ftps://` or\n`ftp://`. Send it with `fileLoginUser` and `fileLoginPassword`. Not used for a host of kind `file_login`, whose login is `serverPage`, `user` and `key`."
        },
        "fileLoginPassword": {
          "type": [
            "null",
            "string"
          ],
          "description": "The file login's password. Kept write-only with the connection, never shown again."
        },
        "fileLoginPort": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The file login's port when the address names none (22 for SFTP, 21 for FTP)."
        },
        "fileLoginProtocol": {
          "type": [
            "null",
            "string"
          ],
          "description": "A scheme in the address wins."
        },
        "fileLoginUser": {
          "type": [
            "null",
            "string"
          ],
          "description": "The file login's user name."
        },
        "hostId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The host the member picked, one of the `id` values of the host list."
        },
        "keepHistory": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Connect only: true to start keeping the server's performance history with a new connection (the Connect form's pre-ticked box). Ignored for a connection that already exists."
        },
        "key": {
          "type": [
            "null",
            "string"
          ],
          "description": "The panel key made for this one server, or the file login's password for a host of kind `file_login`. Stored write-only, never shown again."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "What the member calls the server. Optional: it defaults to `My {host} server`. Unique in the workspace ignoring case."
        },
        "queryAddress": {
          "type": [
            "null",
            "string"
          ],
          "description": "Connect only: the server's public IPv4 address for its status, saved with the connection. Send it with `queryPort`; both empty leave a saved address as it is."
        },
        "queryPort": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Connect only: the game's query port, 1024 to 65535."
        },
        "serverPage": {
          "type": [
            "null",
            "string"
          ],
          "description": "The address of the server's page in the panel, for example `https://panel.example.com/server/1a7ce997`: it holds both the panel address and the\nserver. Some hosts accept the server's id alone, or the service number; the connect step says which."
        },
        "user": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a host of kind `file_login`: the file login's user name, as the host's page shows it. Optional when the address in `serverPage` already names it."
        }
      },
      "type": "object",
      "description": "What a member types to check or connect a rented server. The key is write-only: it goes up here and is never returned by any call."
    },
    "PanelHostChoiceResponse": {
      "properties": {
        "canConnect": {
          "type": "boolean",
          "description": "True when a key can be pasted for it; false for a host with no connection option."
        },
        "hostPage": {
          "type": [
            "null",
            "string"
          ],
          "description": "The host's own public page, or null."
        },
        "id": {
          "type": "string"
        },
        "kind": {
          "type": "string",
          "description": "`panel_address` (paste the server's page address), `fixed_address` (paste the server id), `service_number`, `file_login` (paste the file login's address, user name and password), `no_connection` or `practice`."
        },
        "listsServers": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True when a connected server's key can list the other servers of the same account at this host, so the member can add them in one step (listPanelMoreServers); absent otherwise."
        },
        "name": {
          "type": "string"
        },
        "verified": {
          "type": "boolean",
          "description": "False for a host RustSC offers as Beta: it works, and RustSC checks its file layout the first time a server is connected."
        }
      },
      "required": [
        "id",
        "name",
        "kind",
        "canConnect",
        "hostPage"
      ],
      "type": "object",
      "description": "One entry of the host list."
    },
    "PanelHostsResponse": {
      "properties": {
        "canManage": {
          "type": "boolean",
          "description": "Whether the caller may connect and disconnect."
        },
        "choices": {
          "items": {
            "$ref": "#/$defs/PanelHostChoiceResponse"
          },
          "type": "array"
        },
        "connections": {
          "items": {
            "$ref": "#/$defs/PanelConnectionResponse"
          },
          "type": "array"
        },
        "keyMaxLength": {
          "format": "int32",
          "type": "integer",
          "description": "The longest key, server page address and name, in characters."
        },
        "nameMaxLength": {
          "format": "int32",
          "type": "integer"
        },
        "practiceEnabled": {
          "type": "boolean",
          "description": "True only where the service is set up with the practice host (a development stack); never in production."
        },
        "serverPageMaxLength": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "choices",
        "connections",
        "canManage",
        "practiceEnabled",
        "keyMaxLength",
        "serverPageMaxLength",
        "nameMaxLength"
      ],
      "type": "object",
      "description": "The host list and the workspace's connections."
    },
    "PanelItemBody": {
      "properties": {
        "expectedBytes": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The saved part's size in bytes, checked when it is put in place; needed only with a saved part."
        },
        "path": {
          "type": [
            "null",
            "string"
          ],
          "description": "The file's path from the server's folder, in its oxide or carbon folder, for example `oxide/plugins/Purge.cs`."
        },
        "savedPart": {
          "type": [
            "null",
            "string"
          ],
          "description": "The saved part to put there, in the server's `rustsc/saved` folder; absent to take the file away while the change is on."
        }
      },
      "type": "object"
    },
    "PanelItemResponse": {
      "properties": {
        "expectedBytes": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ]
        },
        "path": {
          "type": "string"
        },
        "savedPart": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "path"
      ],
      "type": "object"
    },
    "PanelLifecycleResponse": {
      "properties": {
        "hostName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The host's name; absent when the server is not on a panel host."
        },
        "line": {
          "type": [
            "null",
            "string"
          ],
          "description": "One plain sentence that the host owns the server's scheduled starts, stops and restarts; absent when there is nothing to say."
        },
        "onPanelHost": {
          "type": "boolean"
        }
      },
      "required": [
        "onPanelHost"
      ],
      "type": "object"
    },
    "PanelLogResponse": {
      "properties": {
        "file": {
          "type": "string",
          "description": "The log file the lines are from. Send it back with `nextOffset` to read what came after."
        },
        "lines": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The complete lines, oldest first, with passwords and keys removed."
        },
        "nextOffset": {
          "format": "int64",
          "type": "integer",
          "description": "Where the next read starts: just after the last complete line."
        },
        "reason": {
          "type": "string",
          "description": "Empty when lines were read (there may be none yet); `no_log` when the host has no log file in the usual places, `too_large` when this host does not let RustSC read that log and `not_reachable` when the file route did not answer."
        },
        "restarted": {
          "type": "boolean",
          "description": "True when the log is a new file or became shorter, so the lines are its newest and not a continuation."
        },
        "result": {
          "$ref": "#/$defs/PanelActionResponse",
          "description": "How the read ended."
        },
        "skipped": {
          "type": "boolean",
          "description": "True when more arrived since the last read than one answer holds, so the oldest lines were left out."
        }
      },
      "required": [
        "result",
        "reason",
        "file",
        "lines",
        "nextOffset",
        "restarted",
        "skipped"
      ],
      "type": "object",
      "description": "The recent lines of a connected rented server's own log file (read on a press, nothing is kept)."
    },
    "PanelMoreServerConnectedResponse": {
      "properties": {
        "connection": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PanelConnectionResponse",
              "description": "The saved connection, or null when the server was not connected."
            }
          ]
        },
        "name": {
          "type": "string"
        },
        "server": {
          "type": "string"
        },
        "summary": {
          "type": "string",
          "description": "The sentence the check ended with, or why the server was not connected."
        }
      },
      "required": [
        "server",
        "name",
        "connection",
        "summary"
      ],
      "type": "object",
      "description": "How one chosen server ended."
    },
    "PanelMoreServerResponse": {
      "properties": {
        "name": {
          "type": "string",
          "description": "The host's own name for the server; may be empty."
        },
        "server": {
          "type": "string",
          "description": "The server's id at the host, the value to send back in connectPanelMoreServers."
        }
      },
      "required": [
        "server",
        "name"
      ],
      "type": "object",
      "description": "One server of the same account at the host that is not connected yet."
    },
    "PanelMoreServersBody": {
      "properties": {
        "servers": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ]
        }
      },
      "type": "object",
      "description": "The servers to connect with the key of a connected server, by their id at the host."
    },
    "PanelMoreServersConnectResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/PanelMoreServerConnectedResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object",
      "description": "The result of connecting more servers from one account, one item per chosen server."
    },
    "PanelMoreServersResponse": {
      "properties": {
        "offered": {
          "type": "boolean",
          "description": "False on a host where adding more servers from the account is not offered; nothing was sent to the host and servers is empty."
        },
        "result": {
          "$ref": "#/$defs/PanelActionResponse",
          "description": "How the read ended. When it did not work, reason is the one sentence to show."
        },
        "servers": {
          "items": {
            "$ref": "#/$defs/PanelMoreServerResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "offered",
        "result",
        "servers"
      ],
      "type": "object",
      "description": "What the key of a connected server can see at its host that is not connected yet."
    },
    "PanelPluginKeyMadeResponse": {
      "properties": {
        "createdAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "exists": {
          "type": "boolean"
        },
        "expiresAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "hint": {
          "type": [
            "null",
            "string"
          ],
          "description": "The start of the key, to recognise it by. Null when there is no key."
        },
        "key": {
          "type": "string"
        },
        "lastUsedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the plugin last used the key, to within a few minutes. Null when it never has."
        }
      },
      "required": [
        "key",
        "exists",
        "hint",
        "createdAt",
        "expiresAt",
        "lastUsedAt"
      ],
      "type": "object",
      "description": "A plugin key just made. `key` is shown only in this answer and is not stored."
    },
    "PanelPluginKeyResponse": {
      "properties": {
        "createdAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "exists": {
          "type": "boolean"
        },
        "expiresAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "hint": {
          "type": [
            "null",
            "string"
          ],
          "description": "The start of the key, to recognise it by. Null when there is no key."
        },
        "lastUsedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the plugin last used the key, to within a few minutes. Null when it never has."
        }
      },
      "required": [
        "exists",
        "hint",
        "createdAt",
        "expiresAt",
        "lastUsedAt"
      ],
      "type": "object",
      "description": "Whether a connected rented server has a plugin key. Never the key itself."
    },
    "PanelRestartBody": {
      "properties": {
        "dueAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "message": {
          "type": [
            "null",
            "string"
          ],
          "description": "The line players read, up to 200 characters; absent says a plain line with the time left."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the member knows it by, 1 to 40 characters."
        },
        "repeat": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PanelRestartRepeatBody",
              "description": "Makes the restart repeat. Then dueAt is not read: the first run is the next one the repeat names."
            }
          ]
        },
        "warnSeconds": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many seconds before the restart players are told, 0 to 3600; absent or 0 says nothing."
        },
        "warnings": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "When players are told, in seconds before the restart (each 1 to 3600, at most 5). Given, it replaces warnSeconds; empty says nothing."
        }
      },
      "type": "object"
    },
    "PanelRestartRepeatBody": {
      "properties": {
        "days": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The days it runs on, 1 for Monday to 7 for Sunday; absent or empty is every day."
        },
        "timeOfDay": {
          "type": [
            "null",
            "string"
          ],
          "description": "The time of day, 24 hour as HH:mm, read in timeZone."
        },
        "timeZone": {
          "type": [
            "null",
            "string"
          ],
          "description": "The zone the time is read in, for example Australia/Brisbane."
        }
      },
      "type": "object"
    },
    "PanelRestartRepeatResponse": {
      "properties": {
        "days": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": "array",
          "description": "1 for Monday to 7 for Sunday; empty is every day."
        },
        "timeOfDay": {
          "type": "string"
        },
        "timeZone": {
          "type": "string"
        }
      },
      "required": [
        "timeOfDay",
        "timeZone",
        "days"
      ],
      "type": "object"
    },
    "PanelRestartResponse": {
      "properties": {
        "dueAt": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "line": {
          "type": [
            "null",
            "string"
          ],
          "description": "The last thing that happened to it, in plain words; absent before it was sent."
        },
        "message": {
          "type": [
            "null",
            "string"
          ]
        },
        "name": {
          "type": "string"
        },
        "repeat": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PanelRestartRepeatResponse",
              "description": "Present for a restart that repeats: dueAt is its next run."
            }
          ]
        },
        "skipReason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why a missed restart was skipped: missed, intentional_stop or paused_for_wipe."
        },
        "state": {
          "type": "string",
          "description": "waiting, running, done, failed or missed."
        },
        "warnSeconds": {
          "format": "int32",
          "type": "integer"
        },
        "warnings": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": "array",
          "description": "When players are told, in seconds before the restart, longest first; empty says nothing."
        }
      },
      "required": [
        "id",
        "name",
        "dueAt",
        "warnSeconds",
        "state",
        "warnings"
      ],
      "type": "object"
    },
    "PanelRestartRouteResponse": {
      "properties": {
        "canWarn": {
          "type": "boolean",
          "description": "False where the host gives no way to say a line to players first; warnSeconds is then not used."
        },
        "hostName": {
          "type": "string"
        },
        "line": {
          "type": [
            "null",
            "string"
          ],
          "description": "The one sentence for a restart that is not offered."
        },
        "offered": {
          "type": "boolean",
          "description": "False where the host offers no restart through its own power control yet; a save is then refused with not_offered."
        }
      },
      "required": [
        "hostName",
        "offered",
        "canWarn"
      ],
      "type": "object"
    },
    "PanelSavedConsoleBody": {
      "properties": {
        "address": {
          "type": [
            "null",
            "string"
          ],
          "description": "The console's address, `host` or `host:port` (port 28016 when none). Empty with no password and no `fromHost` removes the console."
        },
        "fromHost": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True to read the console password (and, with no address, the address) from the host's own startup values again."
        },
        "password": {
          "type": [
            "null",
            "string"
          ],
          "description": "A new console password. Left empty with an address, the saved password is kept. Kept write-only, never shown again."
        }
      },
      "type": "object",
      "description": "A change to the console saved with a connected rented server."
    },
    "PanelSavedConsoleResponse": {
      "properties": {
        "address": {
          "type": [
            "null",
            "string"
          ],
          "description": "The console's address, `host:port`, or null when none is saved."
        },
        "hostCanTell": {
          "type": "boolean",
          "description": "True when the host's own API can say where the console is and its password, so it can be read from the host again."
        },
        "passwordSaved": {
          "type": "boolean",
          "description": "True when a console password is kept with it."
        }
      },
      "required": [
        "address",
        "passwordSaved",
        "hostCanTell"
      ],
      "type": "object",
      "description": "The console saved with a connected rented server. Never its password."
    },
    "PanelScheduleResponse": {
      "properties": {
        "changes": {
          "items": {
            "$ref": "#/$defs/PanelChangeResponse"
          },
          "type": "array"
        },
        "filesSwitchOn": {
          "type": "boolean",
          "description": "The saved choice of setServerPanelExecutor. While it is false, saved temporary changes and wipes wait and do not run; restarts do not need it."
        },
        "onPanelHost": {
          "type": "boolean"
        },
        "restartRoute": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PanelRestartRouteResponse",
              "description": "What the member's host offers for a saved restart; absent for a server with an agent."
            }
          ]
        },
        "restarts": {
          "items": {
            "$ref": "#/$defs/PanelRestartResponse"
          },
          "type": "array",
          "description": "The restarts saved for the server, oldest first."
        },
        "templates": {
          "items": {
            "$ref": "#/$defs/PanelWipeTemplateResponse"
          },
          "type": "array",
          "description": "The wipe templates saved for the server, by name."
        },
        "wipeRoute": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PanelWipeRouteResponse",
              "description": "Whether the host offers a wipe; absent where no route can wipe on this host (and for a server with an agent), and then no wipe is offered at all."
            }
          ]
        },
        "wipes": {
          "items": {
            "$ref": "#/$defs/PanelWipeResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "onPanelHost",
        "changes",
        "wipes",
        "restarts",
        "templates"
      ],
      "type": "object"
    },
    "PanelSetupResponse": {
      "properties": {
        "console": {
          "type": "boolean",
          "description": "True when the form shows the console part: a route on this host reaches the game's own console and no other part of the form asks for it."
        },
        "consoleAddress": {
          "type": [
            "null",
            "string"
          ],
          "description": "Where the host says the console is, `host:port`, or absent."
        },
        "consolePasswordFromHost": {
          "type": "boolean",
          "description": "True when the host's startup values hold the console password: send `consoleFromHost` to use it. The password itself is never in an answer."
        },
        "queryAddress": {
          "type": [
            "null",
            "string"
          ],
          "description": "The server's public IPv4 address the host shows, or absent."
        },
        "queryPort": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The query port the host shows, or absent."
        }
      },
      "required": [
        "console",
        "consolePasswordFromHost"
      ],
      "type": "object",
      "description": "The rest of the Connect form, filled where the host's own API says. No password is in it."
    },
    "PanelStartupBody": {
      "properties": {
        "value": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object",
      "description": "A new value for one startup setting. It applies when the server next starts."
    },
    "PanelStartupResponse": {
      "properties": {
        "result": {
          "$ref": "#/$defs/PanelActionResponse"
        },
        "values": {
          "items": {
            "$ref": "#/$defs/PanelStartupValueResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "result",
        "values"
      ],
      "type": "object",
      "description": "The startup values of a connected server."
    },
    "PanelStartupValueResponse": {
      "properties": {
        "editable": {
          "type": "boolean",
          "description": "Whether the member's key may change it."
        },
        "name": {
          "type": "string"
        },
        "secret": {
          "type": "boolean",
          "description": "True for a password or key the host keeps (for example the console password). Only the workspace Owner sees and changes its value; for anyone else the value is empty and it cannot be changed."
        },
        "value": {
          "type": "string"
        }
      },
      "required": [
        "name",
        "value",
        "editable"
      ],
      "type": "object",
      "description": "One startup value the host keeps for a server."
    },
    "PanelWipeBody": {
      "properties": {
        "backUpFirst": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True backs up the server once it has stopped and before the wipe changes anything, and the wipe does not go on if the backup cannot be made. Absent is false. 409 not_offered where wipeRoute.backUpFirstOffered is false."
        },
        "categories": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "What to remove: map, blueprints, player_data and clans."
        },
        "deletions": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Files deleted at the wipe and not put back: a path, or a name pattern with * and ? in the last name, in the oxide or carbon folder. Needs wipeRoute.filesOffered."
        },
        "dueAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "files": {
          "items": {
            "$ref": "#/$defs/PanelWipeCopyBody"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Files put in place at the wipe until the next wipe, which takes them out and puts the originals back. Needs wipeRoute.filesOffered."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the member knows it by, 1 to 40 characters."
        },
        "pauseRestarts": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True pauses the usual restarts on the wipe's day until the wipe ran. Absent is false."
        },
        "pluginUpdates": {
          "items": {
            "$ref": "#/$defs/PanelWipeCopyBody"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Plugin files replaced at the wipe and kept; a plugin that does not load gets its earlier file back where the host shows the game's answer. Needs wipeRoute.filesOffered."
        },
        "repeat": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PanelWipeRepeatBody",
              "description": "Makes the wipe repeat, weekly or on the force wipe day. Then dueAt is not read: the first run is the next one the repeat names."
            }
          ]
        },
        "saveFolder": {
          "type": [
            "null",
            "string"
          ],
          "description": "The server's save folder in its files, for example `server/rust`."
        },
        "startAfter": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "False leaves the game stopped at the end. Absent starts it."
        },
        "warning": {
          "type": [
            "null",
            "string"
          ],
          "description": "The line said in game chat first; absent says nothing."
        },
        "warnings": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "When players are told before the wipe, in seconds before it (each 1 to 3600, at most 5); absent or empty says nothing before it."
        }
      },
      "type": "object"
    },
    "PanelWipeCopyBody": {
      "properties": {
        "from": {
          "type": [
            "null",
            "string"
          ],
          "description": "The file to copy there, kept in RustSC's folder on the server, under `rustsc/copies/` or `rustsc/saved/`."
        },
        "path": {
          "type": [
            "null",
            "string"
          ],
          "description": "Where the file goes, in the server's oxide or carbon folder, for example `oxide/data/Kits.json`. For a plugin update, `oxide/plugins/Name.cs` or `carbon/plugins/Name.cs`."
        }
      },
      "type": "object"
    },
    "PanelWipeCopyResponse": {
      "properties": {
        "from": {
          "type": "string"
        },
        "path": {
          "type": "string"
        }
      },
      "required": [
        "path",
        "from"
      ],
      "type": "object"
    },
    "PanelWipePreviewLineResponse": {
      "properties": {
        "step": {
          "type": "string"
        },
        "text": {
          "type": "string"
        }
      },
      "required": [
        "step",
        "text"
      ],
      "type": "object"
    },
    "PanelWipePreviewResponse": {
      "properties": {
        "lines": {
          "items": {
            "$ref": "#/$defs/PanelWipePreviewLineResponse"
          },
          "type": "array",
          "description": "Every step of the wipe in order, in plain words."
        }
      },
      "required": [
        "lines"
      ],
      "type": "object"
    },
    "PanelWipeRepeatBody": {
      "properties": {
        "days": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The days it runs on, 1 for Monday to 7 for Sunday; absent or empty is every day. Not read with forceWipeDay."
        },
        "forceWipeDay": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True runs it every month on the force wipe day, minutesAfter the monthly update."
        },
        "minutesAfter": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Minutes after the monthly update, 0 to 1440; absent is 60."
        },
        "timeOfDay": {
          "type": [
            "null",
            "string"
          ],
          "description": "The time of day, 24 hour as HH:mm, read in timeZone. Not read with forceWipeDay."
        },
        "timeZone": {
          "type": [
            "null",
            "string"
          ],
          "description": "The zone the time and the wipe's day are read in, for example Australia/Brisbane."
        }
      },
      "type": "object"
    },
    "PanelWipeRepeatResponse": {
      "properties": {
        "days": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": "array",
          "description": "1 for Monday to 7 for Sunday; empty is every day (or the force wipe day)."
        },
        "forceWipeDay": {
          "type": "boolean",
          "description": "True for a wipe on the force wipe day."
        },
        "minutesAfter": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "timeOfDay": {
          "type": [
            "null",
            "string"
          ]
        },
        "timeZone": {
          "type": "string"
        }
      },
      "required": [
        "timeZone",
        "days"
      ],
      "type": "object"
    },
    "PanelWipeResponse": {
      "properties": {
        "backUpFirst": {
          "type": "boolean",
          "description": "True when the wipe takes a backup first."
        },
        "categories": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "deletions": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "dueAt": {
          "format": "date-time",
          "type": "string"
        },
        "files": {
          "items": {
            "$ref": "#/$defs/PanelWipeCopyResponse"
          },
          "type": "array"
        },
        "id": {
          "type": "string"
        },
        "line": {
          "type": [
            "null",
            "string"
          ]
        },
        "name": {
          "type": "string"
        },
        "pauseRestarts": {
          "type": "boolean"
        },
        "pluginUpdates": {
          "items": {
            "$ref": "#/$defs/PanelWipeCopyResponse"
          },
          "type": "array"
        },
        "repeat": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PanelWipeRepeatResponse",
              "description": "Present for a wipe that repeats: dueAt is its next run."
            }
          ]
        },
        "saveFolder": {
          "type": "string"
        },
        "skipReason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why a missed wipe was skipped: missed."
        },
        "stages": {
          "items": {
            "$ref": "#/$defs/PanelWipeStageResponse"
          },
          "type": "array",
          "description": "What the wipe did, step by step, kept while it runs; a wipe that was cut off keeps the steps it finished. Empty before it runs."
        },
        "startAfter": {
          "type": "boolean"
        },
        "state": {
          "type": "string",
          "description": "waiting, running, done, failed or missed."
        },
        "warning": {
          "type": [
            "null",
            "string"
          ]
        },
        "warnings": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": "array",
          "description": "When players are told before it, in seconds; empty says nothing before it."
        }
      },
      "required": [
        "id",
        "name",
        "dueAt",
        "state",
        "categories",
        "saveFolder",
        "startAfter",
        "warnings",
        "pauseRestarts",
        "files",
        "deletions",
        "pluginUpdates",
        "stages"
      ],
      "type": "object"
    },
    "PanelWipeRouteResponse": {
      "properties": {
        "backUpFirstOffered": {
          "type": "boolean",
          "description": "True where a wipe can take a backup first (the connection lists and reads files and RustSC's storage is set up)."
        },
        "filesLine": {
          "type": [
            "null",
            "string"
          ],
          "description": "The one sentence where a wipe is offered and its file steps are not."
        },
        "filesOffered": {
          "type": "boolean",
          "description": "True where a wipe can also place files, delete lines and update plugins; files, deletions and pluginUpdates are refused with not_offered otherwise."
        },
        "hostName": {
          "type": "string"
        },
        "line": {
          "type": [
            "null",
            "string"
          ],
          "description": "The one sentence for a wipe that is not offered."
        },
        "offered": {
          "type": "boolean",
          "description": "False where no wipe has run on this kind of host yet, or the last check found a step a wipe cannot do without; a save is then refused with not_offered."
        }
      },
      "required": [
        "hostName",
        "offered"
      ],
      "type": "object"
    },
    "PanelWipeStageResponse": {
      "properties": {
        "line": {
          "type": [
            "null",
            "string"
          ],
          "description": "What happened, in plain words; absent for a step that simply went well."
        },
        "stage": {
          "type": "string"
        },
        "state": {
          "type": "string",
          "description": "done, skipped or failed."
        }
      },
      "required": [
        "stage",
        "state"
      ],
      "type": "object"
    },
    "PanelWipeTemplateBody": {
      "properties": {
        "categories": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "What a wipe from it removes: map, blueprints, player_data and clans."
        },
        "deletions": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Files deleted at the wipe: a path, or a name pattern with * and ? in the last name, in the oxide or carbon folder."
        },
        "files": {
          "items": {
            "$ref": "#/$defs/PanelWipeCopyBody"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Files put in place at the wipe until the next wipe."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the member knows it by, 1 to 40 characters, unique on the server in any case."
        },
        "pluginUpdates": {
          "items": {
            "$ref": "#/$defs/PanelWipeCopyBody"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Plugin files replaced at the wipe and kept."
        },
        "saveFolder": {
          "type": [
            "null",
            "string"
          ]
        },
        "startAfter": {
          "type": [
            "null",
            "boolean"
          ]
        },
        "warning": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object"
    },
    "PanelWipeTemplateResponse": {
      "properties": {
        "categories": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "deletions": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "files": {
          "items": {
            "$ref": "#/$defs/PanelWipeCopyResponse"
          },
          "type": "array"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "pluginUpdates": {
          "items": {
            "$ref": "#/$defs/PanelWipeCopyResponse"
          },
          "type": "array"
        },
        "saveFolder": {
          "type": "string"
        },
        "startAfter": {
          "type": "boolean"
        },
        "warning": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "id",
        "name",
        "categories",
        "saveFolder",
        "startAfter",
        "files",
        "deletions",
        "pluginUpdates"
      ],
      "type": "object"
    },
    "PasskeyAddRequest": {
      "properties": {
        "challengeId": {
          "type": "string"
        },
        "credential": {
          "$ref": "#/$defs/JsonElement",
          "description": "The result of `navigator.credentials.create` as JSON (`credential.toJSON()`)."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "A name the person recognises, such as \"Phone\". Optional: a numbered name is chosen when it is missing."
        }
      },
      "required": [
        "challengeId",
        "credential"
      ],
      "type": "object",
      "description": "Add a passkey: the browser's answer to the creation options."
    },
    "PasskeyOfferRequest": {
      "properties": {
        "off": {
          "type": "boolean",
          "description": "True for \"Don't remind me again\", false to offer it again."
        }
      },
      "required": [
        "off"
      ],
      "type": "object",
      "description": "Turns the passkey offer after sign-in off or back on."
    },
    "PasskeyOptionsResponse": {
      "properties": {
        "challengeId": {
          "type": "string",
          "description": "Send this back, with the credential, in the next request. Works once and expires in minutes."
        },
        "options": {
          "$ref": "#/$defs/JsonElement",
          "description": "The WebAuthn options as JSON, for `PublicKeyCredential.parseRequestOptionsFromJSON` (sign in) or `parseCreationOptionsFromJSON` (add)."
        }
      },
      "required": [
        "challengeId",
        "options"
      ],
      "type": "object",
      "description": "Options for the browser's passkey prompt, and the ID that brings the answer back."
    },
    "PasskeyRenameRequest": {
      "properties": {
        "name": {
          "type": "string"
        }
      },
      "required": [
        "name"
      ],
      "type": "object",
      "description": "Rename a passkey."
    },
    "PasskeyResponse": {
      "properties": {
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string",
          "description": "Passkey ID, for example `pky_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "lastUsedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "name": {
          "type": "string"
        },
        "synced": {
          "type": "boolean",
          "description": "True when the passkey is kept in a password manager or cloud keychain, so it survives losing one device."
        }
      },
      "required": [
        "id",
        "name",
        "createdAt",
        "lastUsedAt",
        "synced"
      ],
      "type": "object",
      "description": "A passkey of the account."
    },
    "PasskeySignInRequest": {
      "properties": {
        "challengeId": {
          "type": "string"
        },
        "credential": {
          "$ref": "#/$defs/JsonElement",
          "description": "The result of `navigator.credentials.get` as JSON (`credential.toJSON()`)."
        }
      },
      "required": [
        "challengeId",
        "credential"
      ],
      "type": "object",
      "description": "Sign in with a passkey: the browser's answer to the options."
    },
    "PerformanceHistoryResponse": {
      "properties": {
        "available": {
          "type": "boolean",
          "description": "False when this cloud keeps no performance history; the series are then empty."
        },
        "bucketSeconds": {
          "format": "int32",
          "type": "integer",
          "description": "The width of one bucket in seconds. A point is the bucket that starts at its `at`."
        },
        "from": {
          "format": "date-time",
          "type": "string",
          "description": "The start of the range."
        },
        "markers": {
          "items": {
            "$ref": "#/$defs/PerformanceMarkerResponse"
          },
          "type": "array",
          "description": "The restarts and wipes RustSC did in the range, oldest first, so a change in a chart can be put next to what was done."
        },
        "range": {
          "type": "string",
          "description": "`hour`, `day`, `week` or `month`."
        },
        "series": {
          "items": {
            "$ref": "#/$defs/PerformanceSeriesResponse"
          },
          "type": "array",
          "description": "One entry for each measurement of the subject (a server's five, a host's seven), in a fixed order. A bucket with no sample has no point: a gap in the points is a gap in the data."
        },
        "to": {
          "format": "date-time",
          "type": "string",
          "description": "The end of the range: when the cloud answered."
        }
      },
      "required": [
        "available",
        "range",
        "from",
        "to",
        "bucketSeconds",
        "series",
        "markers"
      ],
      "type": "object",
      "description": "A server's performance history over one range: the stored measurements in buckets of a fixed width. `available` false means this cloud keeps no history; a server with no samples yet has every series empty."
    },
    "PerformanceMarkerResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": "string",
          "description": "When the operation finished."
        },
        "kind": {
          "type": "string",
          "description": "`restart` or `wipe`."
        },
        "operationId": {
          "type": "string",
          "description": "The operation that did it."
        }
      },
      "required": [
        "kind",
        "at",
        "operationId"
      ],
      "type": "object",
      "description": "A restart or a wipe that RustSC finished."
    },
    "PerformancePointResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": "string",
          "description": "The start of the bucket."
        },
        "average": {
          "format": "double",
          "type": "number"
        },
        "maximum": {
          "format": "double",
          "type": "number"
        },
        "minimum": {
          "format": "double",
          "type": "number"
        },
        "samples": {
          "format": "int32",
          "type": "integer",
          "description": "How many samples the bucket holds."
        }
      },
      "required": [
        "at",
        "samples",
        "average",
        "minimum",
        "maximum"
      ],
      "type": "object",
      "description": "One bucket: the plain average, lowest and highest of the samples taken in it."
    },
    "PerformanceSeriesResponse": {
      "properties": {
        "metric": {
          "type": "string",
          "description": "A stable name. A server's: `server.fps`, `server.players`, `server.entities`, `server.cpu_percent` or `server.memory_bytes`. A host's: `host.cpu_percent`, `host.memory_used_bytes`, `host.network.received_bytes_per_second`, `host.network.sent_bytes_per_second`, `host.disk_used_bytes`, `host.disk_total_bytes` or `host.uptime_seconds`."
        },
        "points": {
          "items": {
            "$ref": "#/$defs/PerformancePointResponse"
          },
          "type": "array",
          "description": "Oldest first."
        },
        "unit": {
          "type": "string",
          "description": "`frames_per_second`, `count`, `percent`, `bytes`, `bytes_per_second` or `seconds`."
        }
      },
      "required": [
        "metric",
        "unit",
        "points"
      ],
      "type": "object",
      "description": "One measurement over the range."
    },
    "PermissionListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/PermissionResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "Always null: the list is returned in one page."
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The number of items."
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount"
      ],
      "type": "object",
      "description": "Every permission a role can hold, in catalog order."
    },
    "PermissionResponse": {
      "properties": {
        "access": {
          "type": "string",
          "description": "`read` when it only reads, `write` when it changes something. Read-only integration keys keep only `read` permissions."
        },
        "appliesTo": {
          "type": "string",
          "description": "The narrowest scope a role holding it can be given at: `workspace`, `server_group` or `server`. A role is given for one server only when it holds a permission that applies to a server."
        },
        "grantable": {
          "type": "boolean",
          "description": "False for the few permissions only the Owner has, which cannot be part of a role you make."
        },
        "name": {
          "type": "string",
          "description": "The name, for example `servers.lifecycle`."
        }
      },
      "required": [
        "name",
        "access",
        "appliesTo",
        "grantable"
      ],
      "type": "object",
      "description": "One permission a role can hold."
    },
    "PermissionSyncHistoryEntryResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": "string"
        },
        "by": {
          "type": "string"
        },
        "change": {
          "type": "string"
        },
        "details": {
          "$ref": "#/$defs/JsonElement",
          "description": "Names and counts: for an applied batch `server`, `sent`, `applied`, `waitingForPlayer`, `notMade` and `changes` (in words); for a pause `scope`, `reason`, `item` and `lastChanges` (when, kind, origin, server). Never a file's text."
        },
        "id": {
          "type": "string"
        },
        "serverId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The server the entry is about; absent when it is about the whole sync."
        }
      },
      "required": [
        "id",
        "at",
        "change",
        "by",
        "details"
      ],
      "type": "object",
      "description": "One entry of the permission sync's history: `change` says what it is (`permission_sync.applied`, `.paused`, `.resumed` and so on), `by` is `sync` or `member`."
    },
    "PermissionSyncHistoryResponse": {
      "properties": {
        "entries": {
          "items": {
            "$ref": "#/$defs/PermissionSyncHistoryEntryResponse"
          },
          "type": "array"
        },
        "next": {
          "type": [
            "null",
            "string"
          ],
          "description": "Pass this as `cursor` to read on; absent when the history ends."
        }
      },
      "required": [
        "entries"
      ],
      "type": "object",
      "description": "A page of the sync's history, newest first (`listPermissionSyncHistory`)."
    },
    "PermissionSyncPausedItemResponse": {
      "properties": {
        "description": {
          "type": "string"
        },
        "key": {
          "type": "string"
        },
        "reason": {
          "type": "string"
        }
      },
      "required": [
        "key",
        "reason",
        "description"
      ],
      "type": "object",
      "description": "An item paused because something kept changing it back; `description` says it in words."
    },
    "PermissionSyncPreviewResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": "string"
        },
        "kind": {
          "type": "string"
        },
        "servers": {
          "items": {
            "$ref": "#/$defs/PermissionSyncPreviewServerResponse"
          },
          "type": "array"
        },
        "tooMany": {
          "type": "boolean",
          "description": "True when a server would change more than a person plausibly makes at once; the portal says so at the top."
        }
      },
      "required": [
        "kind",
        "at",
        "tooMany",
        "servers"
      ],
      "type": "object",
      "description": "The newest dry run. `kind` is `turn_on` or `resume`."
    },
    "PermissionSyncPreviewServerResponse": {
      "properties": {
        "alreadyInPlace": {
          "format": "int32",
          "type": "integer"
        },
        "readable": {
          "type": "boolean",
          "description": "False when its saved files could not be read now: nothing is said about what would change."
        },
        "samples": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The first few things that would change, in words."
        },
        "serverId": {
          "type": "string"
        },
        "serverName": {
          "type": "string"
        },
        "willAdd": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "serverId",
        "serverName",
        "readable",
        "willAdd",
        "alreadyInPlace",
        "samples"
      ],
      "type": "object",
      "description": "What turning the sync on, or a resume, would do to one server. Nothing was sent."
    },
    "PermissionSyncResponse": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "included": {
          "type": "boolean",
          "description": "Managing permissions per server and in Global never needs it."
        },
        "managedGroups": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The groups a Discord role sync manages. The permission sync never reads or writes them (\"Managed by a Discord role sync\")."
        },
        "nextPassAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "pauseReason": {
          "type": [
            "null",
            "string"
          ]
        },
        "paused": {
          "type": "boolean",
          "description": "True when the whole sync is paused. Nothing on any server changes until you resume it."
        },
        "pausedItems": {
          "items": {
            "$ref": "#/$defs/PermissionSyncPausedItemResponse"
          },
          "type": "array"
        },
        "preview": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PermissionSyncPreviewResponse"
            }
          ]
        },
        "servers": {
          "items": {
            "$ref": "#/$defs/PermissionSyncServerResponse"
          },
          "type": "array"
        },
        "sharedItems": {
          "format": "int32",
          "type": "integer",
          "description": "How many things the sync keeps the same."
        },
        "syncedGroups": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The names of the groups the sync keeps the same (so a groups list can mark them Synced), at most 500."
        },
        "waiting": {
          "type": "boolean",
          "description": "True while a request (a dry run, a resume or Check now) is still being answered; read again shortly."
        }
      },
      "required": [
        "included",
        "enabled",
        "paused",
        "waiting",
        "sharedItems",
        "servers",
        "pausedItems",
        "syncedGroups",
        "managedGroups"
      ],
      "type": "object",
      "description": "The workspace's permission sync (`getPermissionSync`)."
    },
    "PermissionSyncServerResponse": {
      "properties": {
        "cannotReason": {
          "type": [
            "null",
            "string"
          ],
          "description": "`no_host` when the server has no host service, so RustSC cannot read its permissions."
        },
        "differingPermissions": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The permissions (lower case, in name order, at most 500) that a group should hold on every server but differ on this one: the plugin is not there, the server could not take it yet, or a change here has not\nstayed long enough to spread. The plugin browser marks each <b>Differs on</b> this server. Empty while the sync is off, paused for the server or before its first pass."
        },
        "lastPassAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "missingGroups": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Groups that vanished from this server by another route (a console, a plugin). They are not deleted elsewhere and their items are left alone here."
        },
        "newPlayers": {
          "type": "string",
          "description": "`wait` (a player who has not joined gets nothing until they do, the default) or `add_before` (their entry is made in the saved files before they join, only while the game is stopped)."
        },
        "notMade": {
          "format": "int32",
          "type": "integer",
          "description": "How many changes the server could not take at the last pass (a permission no plugin registered on a running game, for example)."
        },
        "onlyHere": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Items kept <b>Only on this server</b>: an item's key, or `g:name` for a whole group (its permissions, members and the group itself)."
        },
        "pauseReason": {
          "type": [
            "null",
            "string"
          ]
        },
        "serverId": {
          "type": "string"
        },
        "serverName": {
          "type": "string"
        },
        "starting": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PermissionSyncStartingResponse",
              "description": "How this server hands out its starting group, as the last check read it from the framework's own configuration. Null before the first read."
            }
          ]
        },
        "state": {
          "type": "string"
        },
        "ticked": {
          "type": "boolean",
          "description": "True when the server takes part (it is ticked)."
        },
        "waitingForPlayer": {
          "format": "int32",
          "type": "integer",
          "description": "How many changes wait because the player has no entry on this server yet: they apply after the player's first join."
        },
        "waitingPlayers": {
          "items": {
            "$ref": "#/$defs/PermissionSyncWaitingPlayerResponse"
          },
          "type": "array",
          "description": "The players this server has changes waiting for, because it has not seen them yet: each applies after their first join (the sync never makes an entry for a player who has not joined). At most 100 players; `waitingForPlayer` counts every change."
        }
      },
      "required": [
        "serverId",
        "serverName",
        "ticked",
        "state",
        "waitingForPlayer",
        "notMade",
        "newPlayers",
        "missingGroups",
        "onlyHere",
        "waitingPlayers",
        "differingPermissions"
      ],
      "type": "object",
      "description": "One server in the permission sync as the Global view's options panel shows it."
    },
    "PermissionSyncStartingResponse": {
      "properties": {
        "checkedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When this was read. Press Check again to read it again."
        },
        "exists": {
          "type": "boolean"
        },
        "group": {
          "type": "string"
        },
        "mode": {
          "type": "string"
        }
      },
      "required": [
        "mode",
        "group",
        "exists",
        "checkedAt"
      ],
      "type": "object",
      "description": "How a server hands out its starting group (facts read once from the framework's own configuration, never refreshed silently). `mode` is `group` (the framework adds `group` to every\nplayer at join) or `off` (it adds none, Carbon with its automatic starting group switched off). `exists` is whether that group is in the server's groups file."
    },
    "PermissionSyncWaitingPlayerResponse": {
      "properties": {
        "items": {
          "format": "int32",
          "type": "integer"
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "steamId": {
          "type": "string"
        },
        "things": {
          "items": {
            "$ref": "#/$defs/PermissionSyncWaitingThingResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "steamId",
        "items",
        "things"
      ],
      "type": "object",
      "description": "A player a server has changes waiting for. `name` is the newest name RustSC saw them under on any server of the workspace (null when none); `items` counts everything that waits for them and `things` names the first few."
    },
    "PermissionSyncWaitingThingResponse": {
      "properties": {
        "kind": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "kind",
        "name"
      ],
      "type": "object",
      "description": "One thing that waits for a player: `kind` is `group` (they will be put in the group) or `permission` (they will be given the permission)."
    },
    "PlaceUploadBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "folder": {
          "type": [
            "null",
            "string"
          ],
          "description": "The folder below the framework's, such as `oxide/plugins`."
        },
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "`oxide` or `carbon`."
        },
        "ifExists": {
          "type": [
            "null",
            "string"
          ],
          "description": "`replace` (default; the old file is kept beside it) or `keep_both`."
        }
      },
      "type": "object",
      "description": "Put a finished upload in a folder of the server."
    },
    "PlanCleanUpBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "rules": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The rules to list: `old_logs` and `leftover_world`. Absent lists both."
        }
      },
      "type": "object",
      "description": "Check what can be cleaned up: the rules to list (left out: both) and the optional admission choices."
    },
    "PlanWipeRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "blueprints": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True also resets every player's blueprints. False or absent keeps them."
        },
        "clans": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True also resets the clans. False or absent keeps them."
        },
        "keepMap": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True keeps the map and what was built on it, so only the other categories chosen are reset. Not together with `level`, `levelUrl`, `seed` or `worldSize`."
        },
        "level": {
          "type": [
            "null",
            "string"
          ],
          "description": "The map to wipe to: a bundled map's name (for example `CraggyIsland`) or `Procedural Map` for a generated one (`seed` and\n`worldSize` apply). Absent keeps the server's kind of map: a generated map gets a new seed. Not together with `levelUrl`."
        },
        "levelUrl": {
          "type": [
            "null",
            "string"
          ],
          "description": "The address of a custom map file (`http` or `https`) the game downloads and players download from the game. Not together with `level`."
        },
        "planId": {
          "type": [
            "null",
            "string"
          ],
          "description": "Absent for the simple wipe."
        },
        "playerData": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True also resets player data (deaths, identities, states and tokens). False or absent keeps it."
        },
        "rotation": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/RotationBody",
              "description": "Not together with another choice of map."
            }
          ]
        },
        "seed": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The seed of the new map, 0 to 2147483647. Absent means a new random seed."
        },
        "worldSize": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The world size of the new map in metres, 1000 to 6000. Absent means the current size."
        }
      },
      "type": "object"
    },
    "PlayerHistoryItemResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": "string",
          "description": "When it happened: a session's join time, the time a moderation operation was asked for, or the time observation resumed after a gap."
        },
        "banList": {
          "type": [
            "null",
            "string"
          ],
          "description": "Kicks only: the name of the ban list (`Steam` or a community list) that listed the player when the host removed them because of it. Null for every other kick. The row then reads \"Removed by the ban list\" instead of a kick."
        },
        "by": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationActorResponse",
              "description": "Kicks, bans and unbans: who asked for it."
            }
          ]
        },
        "ended": {
          "type": [
            "null",
            "string"
          ],
          "description": "Sessions: how the end is known. `left`: the host saw the player leave. `unseen`: the host lost sight of the server, so `leftAt` is the last time it saw the player. `server_stopped`: the host saw the game stop. Null with `leftAt`."
        },
        "gapFrom": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "Gaps: the last time the host saw the server before it lost it; `at` is when it saw it again."
        },
        "id": {
          "type": "string",
          "description": "A stable identity of the row within its kind."
        },
        "kind": {
          "type": "string",
          "description": "`session` (a player joined, and maybe left), `gap` (the host could not see the server), `kick`, `ban` or `unban`."
        },
        "leftAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "Sessions: when it ended; null while the host last saw the player connected."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the player was seen under, or for a ban the name stored with it; null when none is known."
        },
        "operationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The kick, ban or unban operation (`op_...`)."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Kicks and bans: the reason given, if any."
        },
        "steamId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The Steam ID as a decimal string; keep it a string. Sessions, kicks, bans and unbans."
        }
      },
      "required": [
        "kind",
        "id",
        "at"
      ],
      "type": "object",
      "description": "One row of the player history. Which members are set depends on `kind`."
    },
    "PlayerHistoryResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/PlayerHistoryItemResponse"
          },
          "type": "array",
          "description": "At most 50 rows, newest first."
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "Pass as `cursor` with the same `search` and `range` for the next page; null on the last page."
        }
      },
      "required": [
        "items"
      ],
      "type": "object",
      "description": "A page of a server's player history: who joined and left, the gaps in which the host could not see\nthe server, and the kicks, bans and unbans made through RustSC, newest first. No address is stored or returned."
    },
    "PlayerInventoryBatchResponse": {
      "properties": {
        "changes": {
          "items": {
            "$ref": "#/$defs/PlayerInventoryChangeResponse"
          },
          "type": "array"
        },
        "reason": {
          "type": [
            "null",
            "string"
          ]
        },
        "revision": {
          "type": [
            "null",
            "string"
          ]
        },
        "state": {
          "type": "string"
        }
      },
      "required": [
        "state",
        "changes"
      ],
      "type": "object",
      "description": "Private outcomes of one saved list of changes; only inventory managers may read this result."
    },
    "PlayerInventoryChangeResponse": {
      "properties": {
        "actual": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "clientId": {
          "type": "string"
        },
        "reason": {
          "type": [
            "null",
            "string"
          ]
        },
        "requested": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "status": {
          "type": "string"
        }
      },
      "required": [
        "clientId",
        "status"
      ],
      "type": "object"
    },
    "PlayerInventoryResponse": {
      "properties": {
        "backpackState": {
          "type": [
            "null",
            "string"
          ],
          "description": "read, none or unavailable for the native equipped backpack; null on an older companion."
        },
        "containers": {
          "items": {
            "$ref": "#/$defs/InventoryContainerResponse"
          },
          "type": "array",
          "description": "The player's containers, `main`, `belt` and `wear`, each with its items by slot."
        },
        "playerName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the game showed."
        },
        "readAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the read finished."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why there is nothing to show: the plugin's reason (`player_not_found`, `player_dead`) or the host's (`companion_unavailable:plugin_missing`)."
        },
        "revision": {
          "type": [
            "null",
            "string"
          ],
          "description": "The inventory's revision: send it back with a removal."
        },
        "state": {
          "type": "string"
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID the read was for."
        }
      },
      "required": [
        "state",
        "steamId",
        "containers"
      ],
      "type": "object",
      "description": "What a finished inventory read found. `state` is `running` until the host has answered, `read` with\nthe containers, or `unavailable` with a reason. Needs players.inventory.read: the operation record never carries this."
    },
    "PlayerItemCatalogueResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/PlayerItemDefinitionResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "readAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "reason": {
          "type": [
            "null",
            "string"
          ]
        },
        "revision": {
          "type": [
            "null",
            "string"
          ]
        },
        "state": {
          "type": "string"
        },
        "total": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "state",
        "items"
      ],
      "type": "object"
    },
    "PlayerItemDefinitionResponse": {
      "properties": {
        "category": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "shortname": {
          "type": "string"
        }
      },
      "required": [
        "shortname",
        "name",
        "category"
      ],
      "type": "object"
    },
    "PlayerLabelResponse": {
      "properties": {
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "label": {
          "type": "string",
          "description": "The label, as typed (1 to 30 characters, )."
        },
        "steamId": {
          "type": "string",
          "description": "The player's Steam ID, 17 digits."
        }
      },
      "required": [
        "steamId",
        "label",
        "createdAt"
      ],
      "type": "object",
      "description": "A word a member keeps against a player on a server. Private to the workspace: never sent to a game, Discord, a public page or an export."
    },
    "PlayerLabelsResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/PlayerLabelResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object",
      "description": "The labels of a server, of one player or of one label."
    },
    "PlayerLinkResponse": {
      "properties": {
        "discordName": {
          "type": "string"
        },
        "discordUserId": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "linkedAt": {
          "format": "date-time",
          "type": "string"
        },
        "source": {
          "type": "string",
          "description": "How the link was proven: `game_code`."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID as a decimal string; keep it a string."
        },
        "steamName": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "id",
        "steamId",
        "discordUserId",
        "discordName",
        "linkedAt",
        "source"
      ],
      "type": "object",
      "description": "An active link: never public, readable only with links.manage in the workspace."
    },
    "PlayerLinksResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/PlayerLinkResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object"
    },
    "PlayerNameResponse": {
      "properties": {
        "firstSeenAt": {
          "format": "date-time",
          "type": "string",
          "description": "The first time RustSC saw the player under this name."
        },
        "lastSeenAt": {
          "format": "date-time",
          "type": "string",
          "description": "The last time RustSC saw the player under this name."
        },
        "name": {
          "type": "string",
          "description": "The name as the game showed it."
        },
        "servers": {
          "format": "int32",
          "type": "integer",
          "description": "On how many servers the name was seen."
        },
        "sessions": {
          "format": "int32",
          "type": "integer",
          "description": "How many sessions carried the name."
        },
        "steamId": {
          "type": "string",
          "description": "The 17 digit Steam ID, as a string."
        }
      },
      "required": [
        "steamId",
        "name",
        "firstSeenAt",
        "lastSeenAt",
        "sessions",
        "servers"
      ],
      "type": "object",
      "description": "One name a player was seen under, once however many sessions carried it (`GET .../player-names`)."
    },
    "PlayerNamesResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/PlayerNameResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "Opaque; pass it as `cursor` for the next page. Null on the last page."
        },
        "totalCount": {
          "format": "int32",
          "type": "integer",
          "description": "Names that match the filters."
        }
      },
      "required": [
        "items",
        "totalCount"
      ],
      "type": "object",
      "description": "One page of names, the newest last seen first, 50 to a page."
    },
    "PlayerNoteResponse": {
      "properties": {
        "body": {
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "createdBy": {
          "$ref": "#/$defs/OperationActorResponse",
          "description": "Who wrote it: an account, never a name."
        },
        "id": {
          "type": "string",
          "description": "The note's ID (`pnt_...`)."
        },
        "playerName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal showed for the player when the note was last written; null when unknown. A label, never an identity."
        },
        "revision": {
          "format": "int32",
          "type": "integer",
          "description": "1 at creation, one more at every edit. Also the `ETag` of a single read, create or edit answer; send it back in `If-Match` to change or remove the note."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID of the player the note is about, as a decimal string."
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        },
        "updatedBy": {
          "$ref": "#/$defs/OperationActorResponse"
        }
      },
      "required": [
        "id",
        "steamId",
        "body",
        "revision",
        "createdAt",
        "createdBy",
        "updatedAt",
        "updatedBy"
      ],
      "type": "object",
      "description": "One private note about a player."
    },
    "PlayerNoteRevisionResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": "string"
        },
        "body": {
          "type": "string"
        },
        "by": {
          "$ref": "#/$defs/OperationActorResponse"
        },
        "revision": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "revision",
        "body",
        "at",
        "by"
      ],
      "type": "object",
      "description": "One text a note has had."
    },
    "PlayerNotesResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/PlayerNoteResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "The cursor of the next page; null on the last page."
        }
      },
      "required": [
        "items"
      ],
      "type": "object",
      "description": "A page of notes, newest change first."
    },
    "PlayerPermissionOperationBody": {
      "properties": {
        "group": {
          "type": [
            "null",
            "string"
          ],
          "description": "The group's name, for the `user.group.*` and `group.*` kinds."
        },
        "kind": {
          "type": [
            "null",
            "string"
          ],
          "description": "`user.group.add`, `user.group.remove`, `user.perm.grant`, `user.perm.revoke`, `group.create`, `group.delete`, `group.perm.grant`, `group.perm.revoke`, `group.parent.set`, `group.title.set`, `group.rank.set` or `staff.set`."
        },
        "level": {
          "type": [
            "null",
            "string"
          ],
          "description": "`player`, `moderator` or `owner`, for `staff.set`."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the game keeps with a staff line, for `staff.set`."
        },
        "parent": {
          "type": [
            "null",
            "string"
          ],
          "description": "The parent group of `group.parent.set`; empty for none."
        },
        "permission": {
          "type": [
            "null",
            "string"
          ],
          "description": "The permission, `plugin.name`, for the `*.perm.*` kinds."
        },
        "rank": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The rank (0 to 1000) of `group.create` and `group.rank.set`."
        },
        "title": {
          "type": [
            "null",
            "string"
          ],
          "description": "The title of `group.create` and `group.title.set`."
        },
        "user": {
          "type": [
            "null",
            "string"
          ],
          "description": "The player's Steam ID (17 digits), for the `user.*` kinds and `staff.set`."
        }
      },
      "type": "object",
      "description": "One thing a member wants to be true about a player or a group."
    },
    "PlayerPermissionTemplateResponse": {
      "properties": {
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string",
          "description": "The template's ID."
        },
        "name": {
          "type": "string"
        },
        "operations": {
          "items": {
            "$ref": "#/$defs/PlayerPermissionOperationBody"
          },
          "type": "array",
          "description": "The changes in order, as a server's pending list holds them."
        }
      },
      "required": [
        "id",
        "name",
        "operations",
        "createdAt"
      ],
      "type": "object",
      "description": "A saved list of group and permission changes. Only data: nothing applies it."
    },
    "PlayerPermissionTemplatesResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/PlayerPermissionTemplateResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object",
      "description": "The workspace's templates, by name."
    },
    "PlayerStatsFiguresResponse": {
      "properties": {
        "averageFps": {
          "format": "double",
          "type": [
            "null",
            "number"
          ],
          "description": "The average frame rate of the period, in frames per second with one decimal; absent when RustSC holds none for it, and for all time."
        },
        "averagePlayers": {
          "format": "double",
          "type": "number",
          "description": "The players online on average over the period, one decimal."
        },
        "averageSessionSeconds": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The average length of a connection in the period, in seconds: play time divided by the connections; absent when nobody connected."
        },
        "busiestHour": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The hour of the day (0 to 23, in timeZone) with the most players on average; absent with no play time and in allTime."
        },
        "busiestWeekday": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The day of the week (0 Monday to 6 Sunday, in timeZone) with the most players on average; absent with no play time and in allTime."
        },
        "busyDays": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many whole days in a row from the start of the wipe the day's most players stayed above half of the first day's; absent when no whole day has passed or nobody played on the first day."
        },
        "busyDaysOngoing": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True when every whole day so far was still busy, so busyDays may grow; absent with busyDays."
        },
        "crashes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many times the game exited without being stopped in the period; absent with uptimePercent."
        },
        "deaths": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Deaths of players in the wipe, whatever the cause; absent with kills."
        },
        "firstHoursPeak": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The most players connected at once in the first surgeHours hours of the wipe; absent with surgeHours."
        },
        "from": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "Where counting began: the start of the period, or the first time RustSC saw a player for all time; absent when nobody was seen."
        },
        "hours": {
          "items": {
            "format": "double",
            "type": "number"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The players online on average in each hour of the day, 24 values from 00:00, in timeZone; absent with busiestHour."
        },
        "kills": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Player kills in the wipe; only for one wipe of one server that has kill and death counts."
        },
        "lowestFps": {
          "format": "double",
          "type": [
            "null",
            "number"
          ],
          "description": "The lowest frame rate of the period, in frames per second with one decimal; absent with averageFps."
        },
        "newPlayers": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Players who connected for the first time; absent for all time, where every player is new."
        },
        "peakAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The first moment that many were connected; absent when nobody played."
        },
        "peakPlayers": {
          "format": "int32",
          "type": "integer",
          "description": "The most players connected at once, on the counted servers together."
        },
        "playSeconds": {
          "format": "int64",
          "type": "integer",
          "description": "Every player's connected time added up, in seconds."
        },
        "previousPlayers": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The different players of the period before (the previous wipe, or the range of the same length before); absent when there is none or nobody played in it."
        },
        "returningPlayers": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many of the previous period's players also played in this period; absent with previousPlayers."
        },
        "servers": {
          "items": {
            "$ref": "#/$defs/PlayerStatsServerResponse"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Each counted server's share; only on the answer for several servers, and not in allTime."
        },
        "starts": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many times the game started in the period; absent with uptimePercent."
        },
        "surgeHours": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The hours at the start of a wipe that firstHoursPeak counts; only for one wipe of one server that RustSC saw from its start."
        },
        "to": {
          "format": "date-time",
          "type": "string",
          "description": "Where counting ended: the next wipe, or now."
        },
        "topKillers": {
          "items": {
            "$ref": "#/$defs/PlayerStatsKillerResponse"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The players with the most kills in the wipe, most first, at most 5; absent with kills."
        },
        "topPlayers": {
          "items": {
            "$ref": "#/$defs/PlayerStatsPlayerResponse"
          },
          "type": "array",
          "description": "The players with the most connected time, most first, at most 5."
        },
        "uniquePlayers": {
          "format": "int32",
          "type": "integer",
          "description": "Different players who connected."
        },
        "uptimePercent": {
          "format": "double",
          "type": [
            "null",
            "number"
          ],
          "description": "The share of the period the game ran, in percent with one decimal, counted from the first run RustSC saw; absent when it saw none in the period."
        },
        "weekdays": {
          "items": {
            "format": "double",
            "type": "number"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The players online on average on each day of the week, 7 values from Monday, in timeZone; absent with busiestWeekday."
        }
      },
      "required": [
        "to",
        "peakPlayers",
        "uniquePlayers",
        "playSeconds",
        "averagePlayers",
        "topPlayers"
      ],
      "type": "object",
      "description": "The figures of one period."
    },
    "PlayerStatsKillerResponse": {
      "properties": {
        "deaths": {
          "format": "int32",
          "type": "integer",
          "description": "The player's deaths in the wipe, whatever the cause."
        },
        "kills": {
          "format": "int32",
          "type": "integer",
          "description": "The player's kills of other players in the wipe."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The newest name the player used when they killed or died; absent when none was seen."
        },
        "steamId": {
          "type": "string",
          "description": "The player's Steam ID, 17 digits."
        }
      },
      "required": [
        "steamId",
        "kills",
        "deaths"
      ],
      "type": "object",
      "description": "A player of the \"Most kills\" list."
    },
    "PlayerStatsPlayerResponse": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The newest name the player used in the period; absent when none was seen."
        },
        "seconds": {
          "format": "int64",
          "type": "integer",
          "description": "The player's connected time in the period, in seconds."
        },
        "steamId": {
          "type": "string",
          "description": "The player's Steam ID, 17 digits."
        }
      },
      "required": [
        "steamId",
        "seconds"
      ],
      "type": "object",
      "description": "A player of a \"Most played\" list."
    },
    "PlayerStatsResponse": {
      "properties": {
        "allTime": {
          "$ref": "#/$defs/PlayerStatsFiguresResponse",
          "description": "The figures of everything RustSC holds for the same servers."
        },
        "period": {
          "type": "string",
          "description": "The period counted: wipe, 7d, 30d or all. A server with no known wipe answers all."
        },
        "selected": {
          "$ref": "#/$defs/PlayerStatsFiguresResponse",
          "description": "The figures of the period."
        },
        "timeZone": {
          "type": "string",
          "description": "The zone the busy hours are in."
        },
        "wipeStart": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The start of the wipe counted, for period wipe."
        },
        "wipes": {
          "items": {
            "$ref": "#/$defs/PlayerStatsWipeResponse"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The server's wipes, newest first; only for one server, and empty when none is known."
        }
      },
      "required": [
        "period",
        "timeZone",
        "selected",
        "allTime"
      ],
      "type": "object",
      "description": "The player stats of one server or of several servers together."
    },
    "PlayerStatsServerResponse": {
      "properties": {
        "peakAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The first moment that many were connected; absent when nobody played."
        },
        "peakPlayers": {
          "format": "int32",
          "type": "integer",
          "description": "The most players connected to it at once."
        },
        "playSeconds": {
          "format": "int64",
          "type": "integer",
          "description": "Every player's connected time on it added up, in seconds."
        },
        "serverId": {
          "type": "string",
          "description": "The server, `srv_...`."
        },
        "uniquePlayers": {
          "format": "int32",
          "type": "integer",
          "description": "Different players who connected to it."
        }
      },
      "required": [
        "serverId",
        "peakPlayers",
        "uniquePlayers",
        "playSeconds"
      ],
      "type": "object",
      "description": "One server's share of the period, on the answer for several servers."
    },
    "PlayerStatsWipeResponse": {
      "properties": {
        "averageFps": {
          "format": "double",
          "type": [
            "null",
            "number"
          ],
          "description": "The wipe's average frame rate, in frames per second with one decimal; only on the newest finished wipes, absent when RustSC holds none for it."
        },
        "deaths": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Deaths of players in this wipe, whatever the cause; absent with kills."
        },
        "endedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the next wipe began; absent for the current one."
        },
        "kills": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Player kills in this wipe; only on the newest wipes, absent when RustSC holds no count for it."
        },
        "lowestFps": {
          "format": "double",
          "type": [
            "null",
            "number"
          ],
          "description": "The wipe's lowest frame rate, in frames per second with one decimal; absent with averageFps."
        },
        "partial": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True when RustSC only held part of this wipe, so peakPlayers and uniquePlayers are at least those numbers; absent when the wipe has no figures."
        },
        "peakPlayers": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The most players connected at once in this wipe; only on the newest finished wipes."
        },
        "startedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the wipe's world was created; pass it as wipeStart to read this wipe."
        },
        "uniquePlayers": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Different players who connected in this wipe; only on the newest finished wipes."
        }
      },
      "required": [
        "startedAt"
      ],
      "type": "object",
      "description": "One wipe of the server."
    },
    "PlayerSummariesResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/PlayerSummaryResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object",
      "description": "The summaries of the players asked for, in the order asked."
    },
    "PlayerSummaryResponse": {
      "properties": {
        "connected": {
          "type": "boolean"
        },
        "detailsHidden": {
          "type": "boolean",
          "description": "True when labels and the note count are left out because the caller lacks players.moderate."
        },
        "discordName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The Discord name of the player's link, so a moderator can contact the player in Discord. Absent when the player has not linked, when the name is not known yet and when the caller lacks players.moderate on the server."
        },
        "firstSeenAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The first time RustSC saw them connected."
        },
        "labels": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The private labels; absent when hidden."
        },
        "lastSeenAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The last time RustSC saw them; absent while they are connected."
        },
        "names": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The names they were seen under on this server, newest first, at most 5."
        },
        "noteCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many private notes the player has; absent when hidden."
        },
        "secondsSeen": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "Seconds in sessions that ended, as RustSC observed them: not play time, and the session in progress is not counted."
        },
        "seen": {
          "type": "boolean",
          "description": "False when RustSC never saw this Steam ID on the server; the other facts are then absent."
        },
        "steam": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PlayerSummarySteamResponse",
              "description": "The Steam facts of the newest join check; absent when none was kept (Steam lookup off, or never checked) or hidden."
            }
          ]
        },
        "steamHidden": {
          "type": "boolean",
          "description": "True when the Steam facts are left out because the caller lacks players.read.sensitive."
        },
        "steamId": {
          "type": "string",
          "description": "The player's Steam ID, 17 digits."
        }
      },
      "required": [
        "steamId",
        "seen",
        "names",
        "connected",
        "steamHidden",
        "detailsHidden"
      ],
      "type": "object",
      "description": "What RustSC knows about one player on one server."
    },
    "PlayerSummarySteamResponse": {
      "properties": {
        "accountCreatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the Steam account was created; Steam leaves it out of every profile that is not public."
        },
        "communityBanned": {
          "type": [
            "null",
            "boolean"
          ]
        },
        "daysSinceLastBan": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Days since the latest VAC or game ban; read it only when a ban count is above zero."
        },
        "gameBans": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "observedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When RustSC last asked Steam about this player."
        },
        "unavailable": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why Steam gave no facts at that time (for example `private_profile` is not one: that is a visibility); absent when it answered."
        },
        "vacBans": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "visibility": {
          "type": [
            "null",
            "string"
          ],
          "description": "`public` or `private`."
        }
      },
      "required": [
        "observedAt"
      ],
      "type": "object",
      "description": "The Steam facts a join check kept about a player. A fact Steam did not give is absent, never zero."
    },
    "PlayerUpkeepResponse": {
      "properties": {
        "alertsOn": {
          "type": "boolean"
        },
        "cupboards": {
          "items": {
            "$ref": "#/$defs/UpkeepCupboardResponse"
          },
          "type": "array"
        },
        "tracking": {
          "type": "boolean"
        },
        "trail": {
          "items": {
            "$ref": "#/$defs/UpkeepTrailResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "tracking",
        "alertsOn",
        "cupboards",
        "trail"
      ],
      "type": "object"
    },
    "PlayersResponse": {
      "properties": {
        "connected": {
          "items": {
            "$ref": "#/$defs/ConnectedPlayerResponse"
          },
          "type": "array",
          "description": "One entry per connected player, by name A to Z (case-insensitive), then Steam ID."
        },
        "joining": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "Connections still loading. The game gives a count, not who they are."
        },
        "maxPlayers": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ]
        },
        "observedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the host read the game; null without an observation."
        },
        "players": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "Connected players as the game counts them."
        },
        "queued": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "Players waiting to join; a count only."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why the players are unavailable: `no_observation` (no reading arrived within the read\nwait, for example while the host is offline), or the host's reason, such as\n`rcon_unavailable` when the game does not answer. Null when observed."
        },
        "sleeping": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "Sleeping players. The game's reads used here do not give them, so this is always null for now."
        },
        "source": {
          "type": [
            "null",
            "string"
          ],
          "description": "`rcon`: the server's own WebRCON reads (`serverinfo` and `playerlist`)."
        },
        "state": {
          "type": "string",
          "description": "`observed`, or `unavailable` when the game could not be read or no observation arrived in time."
        }
      },
      "required": [
        "state",
        "connected"
      ],
      "type": "object",
      "description": "The players connected to a server now: one observation of the\ngame, the same one the live `server.players` feed shows. `state` `unavailable` is\nnever an empty server: the counts are then null and `connected` is empty."
    },
    "PluginAddressResponse": {
      "properties": {
        "fileName": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `file`: the file name it would be installed under."
        },
        "kind": {
          "type": "string",
          "description": "`listing` (a plugin's page on a marketplace Find plugins searches: `plugin` is that listing, with its install state and primary action), `marketplace` (a page of\na plugin marketplace RustSC does not read, or a page of a searched one that is not a plugin's page, or a listing it does not have: `website` and `link`), `file`\n(an https address of a `.cs` file: check it with `checkPluginAddress`, then install with `installServerPlugin` marketplace `address`), `archive` or\n`unreadable` (with `reason`)."
        },
        "link": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `marketplace`: the pasted page, to open on the website (https on one of its hosts)."
        },
        "plugin": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/FoundPluginResponse",
              "description": "For `listing`: the listing, as a Find plugins result."
            }
          ]
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `unreadable`: `not_an_address`, `not_https`, `private_address` or `not_a_plugin`; for `marketplace`: `not_listed` when the searched marketplace does not have the page's plugin, or `unavailable` when it could not be asked. Null otherwise."
        },
        "site": {
          "type": [
            "null",
            "string"
          ],
          "description": "The site of the address, without `www.`: the only part of it RustSC repeats."
        },
        "website": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PluginWebsiteResponse",
              "description": "For `listing` and `marketplace`: the website."
            }
          ]
        }
      },
      "required": [
        "kind",
        "reason",
        "site",
        "fileName",
        "website",
        "link",
        "plugin"
      ],
      "type": "object",
      "description": "What a pasted address is."
    },
    "PluginAutoUpdateResponse": {
      "properties": {
        "marketplace": {
          "type": [
            "null",
            "string"
          ],
          "description": "The marketplace an automatic update would come from; null when it cannot."
        },
        "possible": {
          "type": "boolean",
          "description": "True when the marketplace the plugin follows publishes a download RustSC may fetch without an account and lists the plugin: today only `umod`. False for a plugin that follows a marketplace that needs an account or a purchase to download, or that nobody lists; the member adds its new file by hand."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Set exactly when `possible` is false: `no_marketplace` (none lists the plugin), `no_download` (its marketplace needs an account, a purchase or a key, or publishes no download) or `not_listed` (its marketplace does not list it any more)."
        }
      },
      "required": [
        "possible",
        "marketplace",
        "reason"
      ],
      "type": "object",
      "description": "The plain fact \"this plugin can update itself\"."
    },
    "PluginCandidateResponse": {
      "properties": {
        "author": {
          "type": [
            "null",
            "string"
          ],
          "description": "The listing's author as the marketplace names it; set when found and listed."
        },
        "latestVersion": {
          "type": [
            "null",
            "string"
          ],
          "description": "The version this marketplace lists, exactly as written; null when it lists none."
        },
        "marketplace": {
          "type": "string"
        },
        "retrievedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the marketplace's answer was read, UTC; null before the first answer."
        },
        "stale": {
          "type": "boolean",
          "description": "True when the answer is too old to compare; its version is shown but gives no verdict."
        },
        "state": {
          "type": "string",
          "description": "`found`, `not_found`, `ambiguous` (several listings share the file name), `checking` (not answered yet), `failed` (could not be asked and never answered) or `not_available` (RustSC does not look plugins up there yet)."
        },
        "title": {
          "type": [
            "null",
            "string"
          ],
          "description": "The listing's title; set when found."
        },
        "url": {
          "type": [
            "null",
            "string"
          ],
          "description": "The listing's page on the marketplace; set when found and listed."
        }
      },
      "required": [
        "marketplace",
        "state",
        "title",
        "author",
        "url",
        "latestVersion",
        "retrievedAt",
        "stale"
      ],
      "type": "object",
      "description": "What one marketplace says about one plugin."
    },
    "PluginCheckResponse": {
      "properties": {
        "asked": {
          "format": "int32",
          "type": "integer",
          "description": "How many plugin file names were made due (a name already being rechecked or paused after a failure is not counted)."
        },
        "requestedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the request was made; a marketplace answer retrieved after it is the answer to this request."
        }
      },
      "required": [
        "requestedAt",
        "asked"
      ],
      "type": "object",
      "description": "What a request to check plugins now did."
    },
    "PluginDropPreviewResponse": {
      "properties": {
        "framework": {
          "type": [
            "null",
            "string"
          ]
        },
        "rows": {
          "items": {
            "$ref": "#/$defs/PluginDropRowResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "framework",
        "rows"
      ],
      "type": "object"
    },
    "PluginDropRowResponse": {
      "properties": {
        "byDefault": {
          "type": "boolean",
          "description": "True when the file is added without being told \"add anyway\"."
        },
        "canForce": {
          "type": "boolean",
          "description": "True when the member can add the file anyway."
        },
        "fileName": {
          "type": "string"
        },
        "hints": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Hints, never proof, that the update needs more than a swap (`bigger_update`)."
        },
        "libraryVersion": {
          "type": [
            "null",
            "string"
          ]
        },
        "newVersion": {
          "type": [
            "null",
            "string"
          ]
        },
        "plan": {
          "type": "string",
          "description": "`add`, `replace`, `replace_unknown`, `same`, `same_version_changed`, `older`, `cannot_compare`, `unreadable_version`, `on_now` or `name_invalid`."
        },
        "usedBy": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The temporary changes that turn the plugin on."
        }
      },
      "required": [
        "fileName",
        "plan",
        "libraryVersion",
        "newVersion",
        "byDefault",
        "canForce",
        "usedBy",
        "hints"
      ],
      "type": "object"
    },
    "PluginHealingResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "canUndoSwap": {
          "type": "boolean",
          "description": "True when Go back would undo the swap now."
        },
        "cause": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `ambiguous`: `game`, `framework`, `wipe` or `several`."
        },
        "errors": {
          "format": "int32",
          "type": "integer",
          "description": "How many error lines of the version RustSC put in the console showed since it loaded."
        },
        "failedVersion": {
          "type": [
            "null",
            "string"
          ]
        },
        "kind": {
          "type": "string",
          "description": "`update` or `hot_swap`."
        },
        "previousVersion": {
          "type": [
            "null",
            "string"
          ],
          "description": "The version it replaced."
        },
        "putBackWhenFree": {
          "type": "boolean",
          "description": "True when RustSC will put the previous version back by itself once the change that uses the plugin ends."
        },
        "restoredVersion": {
          "type": [
            "null",
            "string"
          ]
        },
        "settingsChanged": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True when the plugin's settings file carries another `Version` than the copy saved before the update; null when that could not be told. A hint, never proof."
        },
        "state": {
          "type": "string",
          "description": "`armed` (waiting for the load result), `loaded` (loaded; watched for repeated errors), `failed_again` (repeated errors), `reverted`, `ambiguous` (left as it is),\n`failed_revert`, and for a swap `reload_failed` and `undone`."
        },
        "version": {
          "type": [
            "null",
            "string"
          ],
          "description": "The version RustSC put in."
        }
      },
      "required": [
        "state",
        "kind",
        "settingsChanged",
        "errors",
        "canUndoSwap",
        "version",
        "previousVersion",
        "putBackWhenFree",
        "failedVersion",
        "restoredVersion",
        "at",
        "cause"
      ],
      "type": "object",
      "description": "What self healing did about an update RustSC applied."
    },
    "PluginHeldResponse": {
      "properties": {
        "ready": {
          "type": "boolean",
          "description": "True when the file is in the inbox, ready to be applied."
        },
        "since": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the update was first seen; null before the automatic run has looked."
        },
        "version": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "version",
        "since",
        "ready"
      ],
      "type": "object",
      "description": "An update waiting for the next wipe that counts."
    },
    "PluginInboxFileResponse": {
      "properties": {
        "byDefault": {
          "type": "boolean",
          "description": "True when the file is added without being told \"add anyway\"."
        },
        "canForce": {
          "type": "boolean"
        },
        "fileName": {
          "type": "string"
        },
        "hints": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Hints, never proof: `bigger_update`, `notes:{word}`, `config_version`."
        },
        "libraryVersion": {
          "type": [
            "null",
            "string"
          ]
        },
        "notes": {
          "type": [
            "null",
            "string"
          ],
          "description": "The author's notes for the version, when the file was fetched from an update source that has them."
        },
        "notesCut": {
          "type": "boolean"
        },
        "plan": {
          "type": "string"
        },
        "version": {
          "type": [
            "null",
            "string"
          ],
          "description": "The version in the file's header, or null when it could not be read."
        }
      },
      "required": [
        "fileName",
        "version",
        "plan",
        "libraryVersion",
        "byDefault",
        "canForce",
        "notes",
        "notesCut",
        "hints"
      ],
      "type": "object",
      "description": "One plugin file the last inbox check found."
    },
    "PluginInboxResponse": {
      "properties": {
        "checkedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the last check finished, or null."
        },
        "checking": {
          "type": "boolean",
          "description": "True while the host's answers to the check have not all come back."
        },
        "files": {
          "items": {
            "$ref": "#/$defs/PluginInboxFileResponse"
          },
          "type": "array"
        },
        "problem": {
          "type": [
            "null",
            "string"
          ],
          "description": "A reason code when the last check could not read the folder, or null."
        }
      },
      "required": [
        "checking",
        "checkedAt",
        "problem",
        "files"
      ],
      "type": "object",
      "description": "The inbox folder as the last check saw it."
    },
    "PluginKeptResponse": {
      "properties": {
        "changeId": {
          "type": "string",
          "description": "The saved temporary change (`tch_` identifier)."
        },
        "destination": {
          "type": "string",
          "description": "The item's destination, for example `carbon/plugins/Caravan.cs`."
        }
      },
      "required": [
        "changeId",
        "destination"
      ],
      "type": "object",
      "description": "The schedule item a kept plugin row stands for."
    },
    "PluginLibraryNeedResponse": {
      "properties": {
        "changeId": {
          "type": "string"
        },
        "missing": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The plugin file names the library does not hold."
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "changeId",
        "name",
        "missing"
      ],
      "type": "object",
      "description": "What a temporary change still needs that the library does not hold."
    },
    "PluginLibraryPluginResponse": {
      "properties": {
        "autoNote": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why the automatic update leaves this plugin alone while a newer version exists, or null:\n`on_now`, `busy`, `keep_manual`, `paused`, `edited` (the library copy was changed by hand), `skip_version`, `cannot_compare`,\n`library_version_unknown` or `unreadable_version`."
        },
        "autoPaused": {
          "type": "boolean",
          "description": "True when the plugin kept changing version and the automatic update left it alone until a member resumes it."
        },
        "biggerUpdate": {
          "type": "boolean",
          "description": "A hint, never proof: the waiting version raises the first number (for example 1.9.4 to 2.0.0), which often changes settings or needs a wipe."
        },
        "failure": {
          "type": [
            "null",
            "string"
          ],
          "description": "A reason code when the last change of this plugin failed, shown once, or null."
        },
        "fileName": {
          "type": "string",
          "description": "The plugin file name, such as `CargoTrainEvent.cs`."
        },
        "framework": {
          "type": "string",
          "description": "`oxide` or `carbon`."
        },
        "healing": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PluginHealingResponse",
              "description": "What self healing did about an update RustSC applied, or null when nothing is watched."
            }
          ]
        },
        "held": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PluginHeldResponse",
              "description": "An update waiting for the next wipe, or null."
            }
          ]
        },
        "hints": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "inboxVersion": {
          "type": [
            "null",
            "string"
          ],
          "description": "The version of this plugin the last inbox check found, when it is a candidate for the library."
        },
        "keepManual": {
          "type": "boolean",
          "description": "\"Keep this one manual\": never updated automatically."
        },
        "liveVersion": {
          "type": [
            "null",
            "string"
          ],
          "description": "The newer version in the plugins folder, when state is `newer_in_plugins_folder`."
        },
        "previousVersion": {
          "type": [
            "null",
            "string"
          ],
          "description": "The version a go back returns to; an empty text when a previous copy is kept and its version is not known; null when none is kept."
        },
        "safety": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PluginSafetyResponse",
              "description": "What the safety net saved beside the previous version, or null when nothing was saved."
            }
          ]
        },
        "since": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the library copy was last changed (or first seen), or null."
        },
        "source": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PluginSourceResponse",
              "description": "The GitHub update source's check: null when the plugin has no update source."
            }
          ]
        },
        "state": {
          "type": "string",
          "description": "`in_library`, `missing`, `on_now` or `newer_in_plugins_folder`."
        },
        "swapVersion": {
          "type": [
            "null",
            "string"
          ],
          "description": "The inbox version Swap now would put into the running plugin; only when the hot swap choice is on and a running change has the plugin on."
        },
        "timing": {
          "type": [
            "null",
            "string"
          ],
          "description": "When an update of this plugin is applied: `now` or `next_wipe`; null follows the server's default."
        },
        "updateSource": {
          "type": [
            "null",
            "string"
          ],
          "description": "The plugin's configured GitHub update source, or null."
        },
        "updating": {
          "type": "boolean",
          "description": "True while a file operation of the library is changing this plugin."
        },
        "usedBy": {
          "items": {
            "$ref": "#/$defs/PluginLibraryUseResponse"
          },
          "type": "array"
        },
        "version": {
          "type": [
            "null",
            "string"
          ],
          "description": "The version in the library copy's header, or null when there is none or it cannot be read."
        }
      },
      "required": [
        "framework",
        "fileName",
        "state",
        "version",
        "since",
        "liveVersion",
        "previousVersion",
        "keepManual",
        "usedBy",
        "updating",
        "failure",
        "autoPaused",
        "autoNote",
        "inboxVersion",
        "swapVersion",
        "updateSource",
        "biggerUpdate",
        "source",
        "timing",
        "held",
        "safety",
        "healing",
        "hints"
      ],
      "type": "object",
      "description": "One plugin of a server's plugin library."
    },
    "PluginLibraryResponse": {
      "properties": {
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "The framework the library is for, or null when the server runs both and each plugin names its own."
        },
        "inbox": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PluginInboxResponse",
              "description": "The inbox folder as the last check saw it; null until the inbox has been checked."
            }
          ]
        },
        "inboxFolder": {
          "type": [
            "null",
            "string"
          ],
          "description": "The inbox folder below the framework's folder that the portal and `rustsc plugin-library add` put files in: `data/plugin-inbox` for every library that exists, or\n`rustsc/plugin-inbox` for a library that was new when the function was on. It does not change after the library is first used."
        },
        "needs": {
          "items": {
            "$ref": "#/$defs/PluginLibraryNeedResponse"
          },
          "type": "array",
          "description": "The temporary changes that name plugins the library does not hold, with the file names."
        },
        "observedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the host read its plugin folders for the list."
        },
        "plugins": {
          "items": {
            "$ref": "#/$defs/PluginLibraryPluginResponse"
          },
          "type": "array"
        },
        "reported": {
          "type": "boolean",
          "description": "False until the server's host has sent its plugin list; the library cannot tell what is where before that."
        },
        "settings": {
          "$ref": "#/$defs/PluginLibrarySettingsResponse"
        },
        "suggestions": {
          "items": {
            "$ref": "#/$defs/PluginLibrarySuggestionResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "framework",
        "reported",
        "observedAt",
        "settings",
        "plugins",
        "needs",
        "suggestions",
        "inbox"
      ],
      "type": "object"
    },
    "PluginLibrarySettingsResponse": {
      "properties": {
        "autoCheckedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the automatic run last looked at this server, or null."
        },
        "autoProblem": {
          "type": [
            "null",
            "string"
          ]
        },
        "autoUpdate": {
          "type": "boolean",
          "description": "\"Update the library automatically when a newer version is found in my plugins folder or inbox\". Off until a member turns it on."
        },
        "healingProblem": {
          "type": [
            "null",
            "string"
          ]
        },
        "holdByDefault": {
          "type": "boolean",
          "description": "The server's default for when an automatic run applies an update: true is \"after the next wipe\", false is \"at once\"."
        },
        "hotSwap": {
          "type": "boolean",
          "description": "\"Also swap and reload the plugin on a running set\". A separate choice, off until a member turns it on."
        },
        "selfHealing": {
          "type": "boolean",
          "description": "\"Put the previous version back when an update RustSC applied fails to load\"."
        }
      },
      "required": [
        "autoUpdate",
        "hotSwap",
        "autoProblem",
        "autoCheckedAt",
        "selfHealing",
        "holdByDefault",
        "healingProblem"
      ],
      "type": "object"
    },
    "PluginLibrarySuggestionResponse": {
      "properties": {
        "fileName": {
          "type": "string"
        },
        "framework": {
          "type": "string"
        },
        "libraryVersion": {
          "type": [
            "null",
            "string"
          ]
        },
        "liveVersion": {
          "type": "string"
        }
      },
      "required": [
        "framework",
        "fileName",
        "libraryVersion",
        "liveVersion"
      ],
      "type": "object",
      "description": "A newer version of a library plugin that the server's plugins folder holds."
    },
    "PluginLibraryUseResponse": {
      "properties": {
        "changeId": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "on": {
          "type": "boolean",
          "description": "True when the change is on right now and has the plugin on."
        }
      },
      "required": [
        "changeId",
        "name",
        "on"
      ],
      "type": "object",
      "description": "A temporary change that names a plugin."
    },
    "PluginListingChoiceResponse": {
      "properties": {
        "listings": {
          "items": {
            "$ref": "#/$defs/PluginListingScoreResponse"
          },
          "type": "array",
          "description": "Every marketplace that lists the plugin, best first."
        },
        "state": {
          "type": "string",
          "description": "`confirmed`, `clear` or `not_sure`."
        }
      },
      "required": [
        "state",
        "listings"
      ],
      "type": "object",
      "description": "How sure the choice between listings with the same file name is, with every listing's points and reasons."
    },
    "PluginListingScoreResponse": {
      "properties": {
        "marketplace": {
          "type": "string"
        },
        "points": {
          "format": "int32",
          "type": "integer",
          "description": "The visible score; the weights are the parameters of the register."
        },
        "reasons": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Plain sentences, for example \"Same title.\" and \"Newer than yours (1.4.0).\""
        }
      },
      "required": [
        "marketplace",
        "points",
        "reasons"
      ],
      "type": "object",
      "description": "One marketplace's points for a plugin and the plain reasons behind them."
    },
    "PluginMarketplaceResponse": {
      "properties": {
        "available": {
          "type": "boolean",
          "description": "False while RustSC does not look plugins up on this marketplace yet."
        },
        "id": {
          "type": "string",
          "description": "Its stable code, for example `umod`."
        },
        "installable": {
          "type": "boolean",
          "description": "True when RustSC installs and updates plugins from this marketplace: where it publishes a download address anonymously (uMod), or from the workspace's own Codefling or RustHQ account while RustSC offers that connection. A rented server lists only the marketplaces it installs from, each with this true. Whether one plugin's update can be made is in the update access read."
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "available",
        "installable"
      ],
      "type": "object",
      "description": "A marketplace plugins come from."
    },
    "PluginPriceResponse": {
      "properties": {
        "cents": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ]
        },
        "currency": {
          "type": [
            "null",
            "string"
          ],
          "description": "The ISO currency code the marketplace quoted; null when free or not stated."
        },
        "discountCents": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The discount in the smallest unit of `currency` (`originalCents` less `cents`); null when no discount is stated."
        },
        "discountPercent": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "free": {
          "type": "boolean"
        },
        "originalCents": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ]
        },
        "saleEndsAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the sale ends, UTC, only where the marketplace states it (none of the marketplaces searched does today); null otherwise."
        }
      },
      "required": [
        "free",
        "cents",
        "currency",
        "originalCents",
        "discountCents",
        "discountPercent",
        "saleEndsAt"
      ],
      "type": "object",
      "description": "RustSC converts nothing."
    },
    "PluginRollbackItemResponse": {
      "properties": {
        "direction": {
          "type": "string",
          "description": "`back` (the update can be rolled back) or `forward` (the roll back can be rolled forward again)."
        },
        "framework": {
          "type": "string",
          "description": "`oxide` or `carbon`."
        },
        "key": {
          "type": "string",
          "description": "The plugin file, as the plugin list names it (`key`)."
        },
        "since": {
          "format": "date-time",
          "type": "string",
          "description": "When the last change finished: the update, or the roll back."
        },
        "until": {
          "format": "date-time",
          "type": "string",
          "description": "When the offer ends: 48 hours after the update."
        }
      },
      "required": [
        "framework",
        "key",
        "direction",
        "since",
        "until"
      ],
      "type": "object",
      "description": "One plugin file whose last update can be rolled back, or whose roll back can be undone."
    },
    "PluginRollbacksResponse": {
      "properties": {
        "plugins": {
          "items": {
            "$ref": "#/$defs/PluginRollbackItemResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "plugins"
      ],
      "type": "object",
      "description": "The plugin updates of a server that can be rolled back or forward now."
    },
    "PluginSafetyResponse": {
      "properties": {
        "config": {
          "type": "boolean",
          "description": "The plugin's settings file was saved."
        },
        "data": {
          "type": "boolean",
          "description": "The plugin's data file was saved."
        },
        "folder": {
          "type": "boolean",
          "description": "The plugin's data folder (`data/Name`) was copied beside itself."
        },
        "problem": {
          "type": [
            "null",
            "string"
          ],
          "description": "A reason code when a file could not be saved (for example `no_room`), or null."
        },
        "savedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "config",
        "data",
        "folder",
        "savedAt",
        "problem"
      ],
      "type": "object",
      "description": "What the safety net saved beside the previous version."
    },
    "PluginSourceCandidateResponse": {
      "properties": {
        "id": {
          "type": "string",
          "description": "The asset name or the path in the repository."
        },
        "size": {
          "format": "int64",
          "type": "integer"
        },
        "title": {
          "type": [
            "null",
            "string"
          ]
        },
        "version": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "id",
        "title",
        "version",
        "size"
      ],
      "type": "object"
    },
    "PluginSourceResponse": {
      "properties": {
        "address": {
          "type": "string"
        },
        "candidates": {
          "items": {
            "$ref": "#/$defs/PluginSourceCandidateResponse"
          },
          "type": "array",
          "description": "The files to pick from when more than one could be the plugin (the pick is saved with `sourcePicks` and remembered)."
        },
        "checkedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "checking": {
          "type": "boolean",
          "description": "True while a read of GitHub or a download is not finished."
        },
        "downloading": {
          "type": "boolean",
          "description": "True while the file is being fetched into the inbox."
        },
        "hints": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "latestVersion": {
          "type": [
            "null",
            "string"
          ],
          "description": "The newest version the source has, or null before a check found one."
        },
        "notBefore": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "GitHub asked RustSC to wait: no check starts before this."
        },
        "notes": {
          "type": [
            "null",
            "string"
          ],
          "description": "The author's notes for the newest version (a GitHub release's body as plain text), only while an update is available. The author's words, not RustSC's."
        },
        "notesCut": {
          "type": "boolean",
          "description": "True when the notes were cut at the length RustSC keeps."
        },
        "picked": {
          "type": [
            "null",
            "string"
          ],
          "description": "The file the member picked, or null."
        },
        "problem": {
          "type": [
            "null",
            "string"
          ],
          "description": "A code when the last check found nothing usable: `rate_limited`, `not_found`, `no_release`, `no_plugin_in_release`, `no_plugin_file`, `needs_pick`, `not_a_plugin`,\n`unreachable`, `host_old`, `timed_out`, `download_failed`, `hash_mismatch` or `version_unreadable`."
        },
        "updateAvailable": {
          "type": "boolean",
          "description": "True when the newest version is newer than the library copy."
        }
      },
      "required": [
        "address",
        "checking",
        "checkedAt",
        "problem",
        "latestVersion",
        "updateAvailable",
        "downloading",
        "notes",
        "notesCut",
        "hints",
        "candidates",
        "picked",
        "notBefore"
      ],
      "type": "object",
      "description": "A plugin's GitHub update source and what the last check found."
    },
    "PluginUpdateAccessItemResponse": {
      "properties": {
        "marketplace": {
          "type": "string",
          "description": "The marketplace the plugin follows: `codefling` or `chaoscode` (RustHQ)."
        },
        "pluginId": {
          "type": "string",
          "description": "`plg_` identifier of the plugin."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Set when `state` is not `ready`: `not_owned`, `no_key`, `key_refused`, `not_approved`, `needs_host`, `host_needs_update` or `not_single_file`."
        },
        "state": {
          "type": "string",
          "description": "`ready` (the Update is offered: the account owns the plugin, or the lookup did not come to an answer, which never hides Update), `not_owned` (the connected account does not own it), `needs_setup` (the account is not connected or the marketplace does not accept it) or `link_only` (RustSC cannot make this update)."
        }
      },
      "required": [
        "pluginId",
        "marketplace",
        "state",
        "reason"
      ],
      "type": "object",
      "description": "Whether RustSC can make the update of one plugin."
    },
    "PluginUpdateAccessResponse": {
      "properties": {
        "plugins": {
          "items": {
            "$ref": "#/$defs/PluginUpdateAccessItemResponse"
          },
          "type": "array",
          "description": "One entry for each plugin that has a newer version on Codefling or RustHQ. A plugin that is not listed (uMod, Lone.Design, up to date, Custom) needs no answer: uMod needs no account and the others have no update to make."
        }
      },
      "required": [
        "plugins"
      ],
      "type": "object",
      "description": "Whether RustSC can make the updates the Plugins tab shows, for the plugins that have an update on a marketplace whose download needs the workspace's own account."
    },
    "PluginUpdateResponse": {
      "properties": {
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Set exactly when `state` is `unknown`: `no_marketplace`, `marketplace_not_available`, `checking`, `check_failed`, `check_stale`, `not_listed`, `ambiguous_listing`, `latest_unknown`, `installed_unknown` or `not_comparable`."
        },
        "state": {
          "type": "string",
          "description": "`update_available`, `up_to_date`, `installed_newer` or `unknown`. Never `up_to_date` without a current answer from the selected marketplace."
        }
      },
      "required": [
        "state",
        "reason"
      ],
      "type": "object",
      "description": "The verdict for a plugin on its selected marketplace."
    },
    "PluginUsedByResponse": {
      "properties": {
        "onNow": {
          "type": "boolean"
        },
        "schedule": {
          "type": "string"
        }
      },
      "required": [
        "schedule",
        "onNow"
      ],
      "type": "object",
      "description": "A saved schedule that uses a plugin file. While `onNow` is true the plugin must not be replaced, disabled or removed."
    },
    "PluginWebsiteResponse": {
      "properties": {
        "id": {
          "type": "string",
          "description": "Its code: a marketplace code of Find plugins (`umod`, `codefling`, `chaoscode`) or its own (`lonedesign`, `roguedepot`, `imperialplugins`)."
        },
        "name": {
          "type": "string",
          "description": "The name, as the website writes it."
        },
        "search": {
          "type": [
            "null",
            "string"
          ],
          "description": "An https search address with `{q}` where the words go (URL-encode them); null when the website's search address is not known."
        },
        "searched": {
          "type": "boolean",
          "description": "True when Find plugins searches it; false when the member opens the website to look."
        },
        "site": {
          "type": "string",
          "description": "The https page to open."
        }
      },
      "required": [
        "id",
        "name",
        "searched",
        "site",
        "search"
      ],
      "type": "object",
      "description": "One plugin marketplace."
    },
    "PluginWebsitesResponse": {
      "properties": {
        "websites": {
          "items": {
            "$ref": "#/$defs/PluginWebsiteResponse"
          },
          "type": "array",
          "description": "In the order shown."
        }
      },
      "required": [
        "websites"
      ],
      "type": "object",
      "description": "Every plugin marketplace the Plugins tab lists (`GET .../plugins/websites`)."
    },
    "PolicyVersionsResponse": {
      "properties": {
        "privacy": {
          "type": "string",
          "description": "The version of the Privacy Policy the sign-up page links to, for example `0.8`."
        },
        "terms": {
          "type": "string",
          "description": "The version of the Terms of Service the sign-up page links to, for example `0.6`."
        }
      },
      "required": [
        "terms",
        "privacy"
      ],
      "type": "object",
      "description": "The policy versions in force. A page sends back the versions it showed when the person continued to create an account."
    },
    "PostChannelGroupResponse": {
      "properties": {
        "category": {
          "type": [
            "null",
            "string"
          ],
          "description": "The category's name, or null for channels outside every category."
        },
        "channels": {
          "items": {
            "$ref": "#/$defs/PostChannelResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "category",
        "channels"
      ],
      "type": "object"
    },
    "PostChannelResponse": {
      "properties": {
        "id": {
          "type": "string",
          "description": "The channel's Discord ID, sent back to save it."
        },
        "missing": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "What the bot lacks in this channel, in Discord's words (`View Channel`, `Send Messages`, `Embed Links`); empty when it can post."
        },
        "name": {
          "type": "string",
          "description": "The channel's name in Discord, without the #."
        },
        "postable": {
          "type": "boolean",
          "description": "False when the bot lacks a permission there; IReadOnlyList&lt;string&gt; PostChannelResponse.Missing names them."
        }
      },
      "required": [
        "id",
        "name",
        "postable",
        "missing"
      ],
      "type": "object"
    },
    "PostChannelsResponse": {
      "properties": {
        "groups": {
          "items": {
            "$ref": "#/$defs/PostChannelGroupResponse"
          },
          "type": "array"
        },
        "readAt": {
          "format": "date-time",
          "type": "string",
          "description": "When Discord was read."
        },
        "total": {
          "format": "int32",
          "type": "integer",
          "description": "The number of channels offered, in every group."
        }
      },
      "required": [
        "readAt",
        "groups",
        "total"
      ],
      "type": "object",
      "description": "The channels of the connected Discord server by their Discord names, each with whether the bot can post there. The one picker for alert channels, the status board and rule posts."
    },
    "PowerOnResponse": {
      "properties": {
        "since": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the host started again, UTC; null unless `state` is `ok`."
        },
        "state": {
          "type": "string",
          "description": "`ok` (the host started again after an unexpected stop) or `cannot_tell` (it has not been seen to; this is not a fault). Treat unknown values as `cannot_tell`."
        }
      },
      "required": [
        "state",
        "since"
      ],
      "type": "object",
      "description": "Whether a host was seen to start again by itself after an unexpected stop. RustSC cannot switch a host on and reads no firmware or provider setting."
    },
    "PrepareLibraryPluginBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the server is busy or its host is offline; leave it out to refuse."
            }
          ]
        },
        "plugin": {
          "type": [
            "null",
            "string"
          ],
          "description": "The plugin's name in the library, a plugin file name without `.cs`: letters, digits, dot, underscore and hyphen, at most 64 characters."
        }
      },
      "type": "object",
      "description": "Take a plugin from the library: the host fetches and keeps it."
    },
    "PreviewOwnedEntitiesRequestBody": {
      "properties": {
        "generation": {
          "type": "string",
          "description": "The world generation from a count, so a wipe in between is noticed."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the player, only so the activity line says it; optional, up to 64 characters."
        },
        "steamId": {
          "type": "string",
          "description": "The owner's Steam ID, 17 digits; online or not."
        }
      },
      "required": [
        "steamId",
        "generation"
      ],
      "type": "object",
      "description": "Captures what one player owns."
    },
    "PreviewPluginDropBody": {
      "properties": {
        "files": {
          "items": {
            "$ref": "#/$defs/DroppedPluginBody"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "`oxide` or `carbon`; needed only when the server runs both."
        }
      },
      "type": "object"
    },
    "PreviewRestoreRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        }
      },
      "type": "object",
      "description": "A restore preview: only the optional admission choices."
    },
    "PreviewVariableResponse": {
      "properties": {
        "format": {
          "type": [
            "null",
            "string"
          ]
        },
        "name": {
          "type": "string"
        },
        "source": {
          "type": [
            "null",
            "string"
          ],
          "description": "`sample` or `supplied`; null for a missing value."
        },
        "state": {
          "type": "string",
          "description": "`known`, `missing`, `stale`, `other_process` or `invalid`; every state but known rendered as unknown."
        },
        "type": {
          "type": "string",
          "description": "`count`, `duration`, `bytes`, `percentage`, `timestamp`, `port`, `endpoint`, `text` or `player_name`."
        }
      },
      "required": [
        "name",
        "type",
        "format",
        "state",
        "source"
      ],
      "type": "object"
    },
    "PrivacyExportStatus": {
      "properties": {
        "expiresAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "expiresAt"
      ],
      "type": "object"
    },
    "PrivateProfileRuleBody": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "message": {
          "type": "string"
        },
        "unknown": {
          "type": "string"
        }
      },
      "required": [
        "enabled",
        "unknown",
        "message"
      ],
      "type": "object",
      "description": "Players whose Steam profile is not public are removed."
    },
    "Problem": {
      "properties": {
        "blockingOperationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "`operation_conflict`: the operation blocking this request."
        },
        "blockingState": {
          "type": [
            "null",
            "string"
          ],
          "description": "`operation_conflict`: that operation's state, `queued`, `running` or `outcome_unknown`."
        },
        "capability": {
          "type": [
            "null",
            "string"
          ],
          "description": "`capability_unavailable`: the capability the target lacks."
        },
        "code": {
          "type": "string",
          "description": "Stable machine code from the error catalog. New codes are additive, so clients treat unknown codes as other."
        },
        "currentRevision": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "`revision_conflict`: the current revision of the resource."
        },
        "dependency": {
          "type": [
            "null",
            "string"
          ],
          "description": "`dependency_unavailable`: the dependency that is down."
        },
        "detail": {
          "type": "string",
          "description": "Fixed, safe next step."
        },
        "header": {
          "type": [
            "null",
            "string"
          ],
          "description": "`precondition_required`: the header the request needs, `If-Match`."
        },
        "permission": {
          "type": [
            "null",
            "string"
          ],
          "description": "`forbidden`: the permission that is missing."
        },
        "pointer": {
          "type": [
            "null",
            "string"
          ],
          "description": "`state_conflict` on a body reference: the JSON pointer of the member that refers to it."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "A stable reason within the code, for example `host_offline` or `not_detached`."
        },
        "retryAfterSeconds": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Seconds to wait before repeating, or null when no useful wait is known."
        },
        "retryable": {
          "type": "boolean",
          "description": "True only when repeating the identical request may succeed later without any change and cannot duplicate work."
        },
        "scope": {
          "type": [
            "null",
            "string"
          ],
          "description": "`insufficient_scope`: the OAuth scope the token lacks."
        },
        "state": {
          "type": [
            "null",
            "string"
          ],
          "description": "`state_conflict` and `workspace_unavailable`: the current state, when it may be shown."
        },
        "status": {
          "format": "int32",
          "type": "integer",
          "description": "HTTP status code."
        },
        "title": {
          "type": "string",
          "description": "Short fixed sentence for the code or reason; safe to show."
        },
        "traceId": {
          "type": "string",
          "description": "W3C trace ID of the request."
        },
        "type": {
          "type": "string",
          "description": "`https://docs.rustsc.com/errors/{code}`, a public page per code."
        }
      },
      "required": [
        "type",
        "title",
        "status",
        "detail",
        "code",
        "traceId",
        "retryable",
        "retryAfterSeconds"
      ],
      "type": "object",
      "description": "An error response (RFC 9457 problem details). The required fields are always present; the\nothers appear only for the codes the error catalog names them for."
    },
    "ProfileOverrideResponse": {
      "properties": {
        "fields": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "serverId": {
          "type": "string"
        }
      },
      "required": [
        "serverId",
        "fields"
      ],
      "type": "object",
      "description": "The fields one server keeps for itself."
    },
    "ProfileOverridesBody": {
      "properties": {
        "fields": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Console variables of the profile; an empty list removes the server's overrides."
        }
      },
      "type": "object",
      "description": "The fields one server keeps for itself under a profile."
    },
    "PublicAddressBody": {
      "properties": {
        "address": {
          "type": [
            "null",
            "string"
          ],
          "description": "A public IPv4 address such as `203.0.113.5`; null removes the saved one. Anything else is 422 on `/address`."
        }
      },
      "required": [
        "address"
      ],
      "type": "object",
      "description": "The public IPv4 address to save for a server (`PUT .../reachability/address`)."
    },
    "PublicFeedbackBody": {
      "properties": {
        "kind": {
          "type": [
            "null",
            "string"
          ]
        },
        "message": {
          "type": [
            "null",
            "string"
          ]
        },
        "replyTo": {
          "type": [
            "null",
            "string"
          ],
          "description": "Where to answer, if they want an answer. Optional."
        },
        "website": {
          "type": [
            "null",
            "string"
          ],
          "description": "A field people never see; a filled one means a bot."
        }
      },
      "type": "object",
      "description": "What anyone sends from the public site: text only."
    },
    "PublicSupportRequest": {
      "properties": {
        "email": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "subject": {
          "type": "string"
        },
        "submissionKey": {
          "type": "string"
        },
        "topic": {
          "type": "string"
        },
        "website": {
          "type": "string"
        }
      },
      "required": [
        "email",
        "topic",
        "subject",
        "message"
      ],
      "type": "object",
      "description": "Private form input. No address examples are published in the public schema."
    },
    "PublicSupportResponse": {
      "properties": {
        "detail": {
          "type": "string"
        },
        "operationId": {
          "type": "string"
        },
        "reference": {
          "type": "string"
        },
        "retryable": {
          "type": "boolean"
        },
        "state": {
          "type": "string"
        }
      },
      "required": [
        "operationId",
        "reference",
        "state",
        "detail",
        "retryable"
      ],
      "type": "object",
      "description": "Only an opaque operation reference, state and useful next step leave the endpoint."
    },
    "PutWipeExtraInPlaceBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do while the host is busy or offline: `reject` (the default for a put in place)."
            }
          ]
        },
        "files": {
          "items": {
            "$ref": "#/$defs/WipeFileBody"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "To replace the extra's files while putting it in place: the new list of files the member uploaded (path, size, fingerprint). Absent puts the extra's own files in place. When the\noperation succeeds the extra holds this list."
        }
      },
      "type": "object",
      "description": "Put an extra in place on the running server now."
    },
    "QuickActionListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/QuickActionResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object"
    },
    "QuickActionParameterResponse": {
      "properties": {
        "maximum": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ]
        },
        "minimum": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ]
        },
        "name": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "name",
        "type",
        "minimum",
        "maximum"
      ],
      "type": "object",
      "description": "One thing an action asks for. `type` is `text` (up to `maximum` characters), `item` (an item's short name) or `whole` (`minimum` to `maximum`)."
    },
    "QuickActionPreviewBody": {
      "properties": {
        "arguments": {
          "type": [
            "null",
            "object"
          ]
        },
        "player": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object",
      "description": "What to preview: the player's Steam ID for a player action (leave it out for a server action) and one value per thing the action asks for."
    },
    "QuickActionPreviewResponse": {
      "properties": {
        "actionId": {
          "type": "string"
        },
        "canRun": {
          "type": "boolean",
          "description": "True when the caller holds the permission of every step."
        },
        "context": {
          "type": "string"
        },
        "player": {
          "type": [
            "null",
            "string"
          ]
        },
        "steps": {
          "items": {
            "$ref": "#/$defs/QuickActionPreviewStepResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "actionId",
        "context",
        "player",
        "steps",
        "canRun"
      ],
      "type": "object"
    },
    "QuickActionPreviewStepResponse": {
      "properties": {
        "granted": {
          "type": "boolean",
          "description": "Whether the caller holds the permission on this server now."
        },
        "input": {
          "$ref": "#/$defs/JsonElement",
          "description": "The exact input the step's operation would carry."
        },
        "irreversible": {
          "type": "boolean",
          "description": "True when the step's effect cannot be taken back."
        },
        "kind": {
          "type": "string"
        },
        "permission": {
          "type": "string",
          "description": "The permission this step needs on the server."
        },
        "position": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "position",
        "kind",
        "permission",
        "irreversible",
        "granted",
        "input"
      ],
      "type": "object"
    },
    "QuickActionResponse": {
      "properties": {
        "context": {
          "type": "string",
          "description": "`server` or `player`."
        },
        "id": {
          "type": "string"
        },
        "label": {
          "type": "string"
        },
        "parameters": {
          "items": {
            "$ref": "#/$defs/QuickActionParameterResponse"
          },
          "type": "array"
        },
        "steps": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The operation kinds the action runs, in order."
        }
      },
      "required": [
        "id",
        "label",
        "context",
        "parameters",
        "steps"
      ],
      "type": "object"
    },
    "QuietHoursBody": {
      "properties": {
        "end": {
          "type": "string",
          "description": "For example `07:00`. The same time as the start is refused (`same_time`) while quiet hours are on."
        },
        "on": {
          "type": "boolean"
        },
        "start": {
          "type": "string",
          "description": "For example `22:00`."
        }
      },
      "required": [
        "on",
        "start",
        "end"
      ],
      "type": "object",
      "description": "Quiet hours: clock times written `HH:mm` in the member's own time zone; an end earlier than the start runs past midnight."
    },
    "QuietHoursResponse": {
      "properties": {
        "end": {
          "type": "string"
        },
        "on": {
          "type": "boolean"
        },
        "start": {
          "type": "string"
        }
      },
      "required": [
        "on",
        "start",
        "end"
      ],
      "type": "object"
    },
    "QuietTimeChangeBody": {
      "properties": {
        "categories": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "What is silenced; empty silences all three kinds."
        },
        "endsAt": {
          "format": "date-time",
          "type": "string"
        },
        "revision": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The revision that was read; a different one is answered with 409."
        },
        "startsAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The new start. Ignored once the quiet time has started; absent keeps it."
        }
      },
      "required": [
        "endsAt"
      ],
      "type": "object",
      "description": "A change to a quiet time that has not ended. The scope cannot change. A quiet time that is running keeps its start."
    },
    "QuietTimeCreateBody": {
      "properties": {
        "categories": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "What is silenced: any of `availability`, `operations` and `resources`. Empty or absent silences all three."
        },
        "endsAt": {
          "format": "date-time",
          "type": "string",
          "description": "When it ends (RFC 3339). Must be in the future and after the start."
        },
        "scope": {
          "type": "string",
          "description": "`workspace` (every server and host), `host` (one host) or `server`."
        },
        "startsAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the quiet time starts (RFC 3339). Absent means now."
        },
        "targetId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The host (`host_...`) or server (`srv_...`) for those scopes; absent for `workspace`."
        }
      },
      "required": [
        "scope",
        "endsAt"
      ],
      "type": "object",
      "description": "A new quiet time: a period when alerts of some kinds are not sent for the workspace, a host or a server."
    },
    "QuietTimeListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/QuietTimeResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object",
      "description": "The quiet times that are running or still to come, soonest first."
    },
    "QuietTimeResponse": {
      "properties": {
        "categories": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "What it silences: `availability`, `operations`, `resources`. All three are listed when it silences everything."
        },
        "endsAt": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string",
          "description": "For example `qtm_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "paused": {
          "type": "boolean",
          "description": "True when the quiet time was switched off: it keeps its times but silences nothing."
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "running": {
          "type": "boolean",
          "description": "True from the start until the end."
        },
        "scope": {
          "type": "string",
          "description": "`workspace`, `host` or `server`. Treat unknown values as other."
        },
        "startsAt": {
          "format": "date-time",
          "type": "string"
        },
        "targetId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The host or server; null for the whole workspace."
        }
      },
      "required": [
        "id",
        "scope",
        "targetId",
        "categories",
        "startsAt",
        "endsAt",
        "running",
        "revision",
        "paused"
      ],
      "type": "object",
      "description": "One quiet time."
    },
    "RconAccessResponse": {
      "properties": {
        "address": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a rented server only: the public address its host shows for the game; absent when the host did not say."
        },
        "gamePort": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "For a rented server only: the game's port as its host reports it; absent when the host did not say."
        },
        "listen": {
          "type": [
            "null",
            "string"
          ],
          "description": "`this_computer`, `all_networks` or `other_address` (another tool's game bound to one address); null when not known."
        },
        "password": {
          "type": [
            "null",
            "string"
          ],
          "description": "The password, returned only by `revealRconPassword`. Keep it private."
        },
        "pendingRestart": {
          "type": "boolean",
          "description": "A changed password or listen address waits for the next start of the server."
        },
        "port": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The TCP port of the console (WebRCON), when known."
        },
        "queryPort": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "For a rented server only: the game's query port as its host reports it, or the one saved for the server; absent when unknown."
        },
        "runBy": {
          "type": "string",
          "description": "`rustsc`: RustSC starts the server and its password and listen address can be set here. `other_tool`: another tool runs it. `host`: a rented server; the values are read from its host and nothing is set here."
        },
        "serverId": {
          "type": "string"
        },
        "source": {
          "type": [
            "null",
            "string"
          ],
          "description": "Where the password comes from: `rustsc`, `command_line`, `start_script`, `server_cfg`, `typed` or `host` (a rented server's host shows it); null when none is known."
        },
        "sourceFile": {
          "type": [
            "null",
            "string"
          ],
          "description": "The start script's file name when source is `start_script`."
        },
        "typedSet": {
          "type": "boolean",
          "description": "For a server another tool runs: the Owner typed a password."
        }
      },
      "required": [
        "serverId",
        "runBy",
        "port",
        "listen",
        "source",
        "sourceFile",
        "pendingRestart",
        "typedSet"
      ],
      "type": "object",
      "description": "A server's RCON connection details as its host reports them now. The password is present only in the answer to a reveal."
    },
    "ReachabilityResponse": {
      "properties": {
        "address": {
          "type": [
            "null",
            "string"
          ],
          "description": "The internet address the check tested (the address the server's host connects to RustSC from),\nreturned with the result of a check so you can see what was tested; null when nothing was tested."
        },
        "addressSource": {
          "type": [
            "null",
            "string"
          ],
          "description": "Where `address` came from, in the order they are used: `entered` (typed for the server), `connection` (the address\nthe host connects to RustSC from, as before), `reported` (the public IPv4 the host got from RustSC's own cloud over IPv4) or `game`\n(the public IPv4 address the running game listens on, from the host's latest ports read); null when nothing was tested. Treat unknown\nvalues as `connection`."
        },
        "checkedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the probe ran; null for `not_checked`."
        },
        "enteredAddress": {
          "type": [
            "null",
            "string"
          ],
          "description": "The public IPv4 address typed for this server, which the check tests first; null when none is saved."
        },
        "gamePort": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The applied game port the answer is about; null while the ports are not known."
        },
        "hostAddress": {
          "type": [
            "null",
            "string"
          ],
          "description": "The public IPv4 address RustSC sees for the server's host while it is connected (the cloud's own view of the\nconnection, no other service is asked), which is the address players use when the router forwards the ports. It says nothing about whether the ports are open. Null when the host is offline or connects from a private or\nIPv6 address."
        },
        "nextCheckAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The earliest time another probe of this server may run; null when none is limiting."
        },
        "queryPort": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The applied query port that was asked; null while the ports are not known."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `not_checked`: `not_yet`, `server_stopped`, `server_starting`, `server_not_running`,\n`host_offline`, `ports_unknown`, `address_unknown`, `address_private`, `address_ipv6`, `unsupported` or\n`probe_failed`; null otherwise. Treat unknown values as other."
        },
        "status": {
          "type": "string",
          "description": "`reachable`, `unreachable` or `not_checked`. Treat unknown values as `not_checked`."
        },
        "suggestedAddress": {
          "type": [
            "null",
            "string"
          ],
          "description": "The best public IPv4 address RustSC knows without being told (from the host's connection, the host itself or the game), to pre-fill the\nfield the member types in; null when it knows none."
        }
      },
      "required": [
        "status",
        "reason",
        "gamePort",
        "queryPort",
        "checkedAt",
        "nextCheckAt",
        "address",
        "addressSource",
        "hostAddress",
        "enteredAddress",
        "suggestedAddress"
      ],
      "type": "object",
      "description": "Whether players on the internet can reach a server, as the last check found."
    },
    "ReadFolderRequestBody": {
      "properties": {
        "find": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True to also have the host look for Rust servers in the folder and the folders directly under it (names only, nothing changed); the listing then carries\n`found`. Absent or false is a plain read. A host whose software is older answers without `found`."
        },
        "path": {
          "type": [
            "null",
            "string"
          ],
          "description": "The folder to list, an absolute path on the host, for example `/srv/rust` or `C:\\RustSC\\Servers`. A folder that does not exist is answered with its nearest existing parent."
        },
        "serverId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The server on this host whose backup folder is being chosen (`srv_...`). With it, a member who may manage that server's backups may read folders without the right to add servers. Leave it out otherwise."
        }
      },
      "type": "object",
      "description": "Reads one folder of a host for the folder picker. Nothing is written, admitted or kept."
    },
    "ReadFolderResponse": {
      "properties": {
        "failure": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why the host could not list the folder: `no_access` (it cannot open it), `input_invalid` (a path or system it does not take),\n`unsupported` (this host cannot browse) or `broker_unavailable`. Null when `listing` is set."
        },
        "listing": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/FolderListingResponse",
              "description": "The folder's listing; null when `failure` is set."
            }
          ]
        }
      },
      "type": "object",
      "description": "The answer to a folder read: the listing, or why the host could not give one. A folder the host cannot open is an answer, not an error of\nthe request, so it is a 200 with `failure`; a host that is offline, busy or silent is a problem response instead."
    },
    "ReadItemCatalogueRequestBody": {
      "properties": {
        "cursor": {
          "format": "int32",
          "type": "integer"
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "revision": {
          "type": [
            "null",
            "string"
          ]
        },
        "steamId": {
          "type": "string"
        }
      },
      "required": [
        "steamId"
      ],
      "type": "object",
      "description": "Reads one page of definitions from the running game, at a single revision."
    },
    "ReadPlayerInventoryRequestBody": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the player, only so the activity line says it; optional."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID of the player, 17 digits."
        }
      },
      "required": [
        "steamId"
      ],
      "type": "object",
      "description": "Looks at what one connected player carries."
    },
    "ReadPlayerPermissionsBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "`oxide` or `carbon`, the framework the portal saw; the host checks it against the server's files."
        },
        "group": {
          "type": [
            "null",
            "string"
          ],
          "description": "A group's name: the answer then lists every member of that group (at most 1,500, with truncated set when it was cut) and leaves out the page of players."
        },
        "offset": {
          "format": "int32",
          "type": "integer",
          "description": "How many matching players to skip (the page is 50)."
        },
        "query": {
          "type": [
            "null",
            "string"
          ],
          "description": "A Steam ID or part of a last seen name to look for among the players. A whole Steam ID also returns that player's effective view."
        },
        "registered": {
          "type": "boolean",
          "description": "True to ask for the permissions the loaded plugins registered (the answer is then only `registered`: its `state` (`listed`, `server_stopped` or `unavailable`), the names in order, the `total` and whether the list was cut), asked of the running game. Default false."
        }
      },
      "type": "object",
      "description": "A read of a server's groups, players and staff list."
    },
    "ReadPluginSettingsBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "topic": {
          "type": [
            "null",
            "string"
          ],
          "description": "`files` (the names of its configuration, data and language files), `permissions` or `commands`."
        }
      },
      "type": "object",
      "description": "A read about one plugin: the names of its files, its permissions or its commands."
    },
    "ReadServerFilesBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "area": {
          "type": [
            "null",
            "string"
          ],
          "description": "Leave out for the Oxide or Carbon folder. `rustsc` looks in RustSC's folder of the server instead, where paths start with `rustsc` (topics `folder`, `open` and `search`)."
        },
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "`oxide` or `carbon`: whose folder to look in."
        },
        "offset": {
          "format": "int32",
          "type": "integer",
          "description": "Where the next page of a folder starts (a multiple of the page size the last answer gave); 0 for the first."
        },
        "path": {
          "type": [
            "null",
            "string"
          ],
          "description": "A path below the framework's folder, for example `oxide/config`; for `folder` and `search` the framework's folder itself when left out."
        },
        "query": {
          "type": [
            "null",
            "string"
          ],
          "description": "The part of a name to look for, for `search`."
        },
        "topic": {
          "type": [
            "null",
            "string"
          ],
          "description": "`folder` (the entries of `path`, one page), `tree` (the entries of `path` and of every folder below it, a page of folders from folder number `offset`), `search` (names that hold `query` below `path`) or `open` (the file `path`)."
        }
      },
      "type": "object",
      "description": "A look at the framework's folder of a server."
    },
    "RebootRequiredResponse": {
      "properties": {
        "observedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the host read it, UTC."
        },
        "reasons": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The packages that asked for the reboot, as the operating system lists them; may be empty."
        },
        "since": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the operating system's flag appeared, UTC; null unless `state` is `required`."
        },
        "state": {
          "type": "string",
          "description": "`required`, `not_required`, or `unknown` where the host has no verified way to tell\n(only the Debian family's flag is read). Treat unknown values as unknown."
        }
      },
      "required": [
        "state",
        "since",
        "reasons",
        "observedAt"
      ],
      "type": "object",
      "description": "The reboot-required fact a host reports."
    },
    "ReceiveTimedChangeFolderBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "sendOperationId": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object",
      "description": "The target half of a copy to another host: names the finished send."
    },
    "RecognisePluginAddressBody": {
      "properties": {
        "address": {
          "type": [
            "null",
            "string"
          ],
          "description": "The address the member pasted, at most 2000 characters. It is never fetched by this route and never logged."
        }
      },
      "type": "object",
      "description": "An address to recognise (`POST .../plugins/find/address`)."
    },
    "RecoveryPreferencesResponse": {
      "properties": {
        "applied": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AppliedRecoveryPreferencesResponse"
            }
          ]
        },
        "canEnable": {
          "type": "boolean",
          "description": "Target-scoped configuration and lifecycle grants together, checked again at mutation admission."
        },
        "canManage": {
          "type": "boolean"
        },
        "canRestartAutomatically": {
          "type": "boolean",
          "description": "Whether the caller may turn on the automatic restart of an unresponsive server: configuration write and the force grant on this server."
        },
        "change": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResponse"
            }
          ]
        },
        "connected": {
          "type": "boolean"
        },
        "observation": {
          "type": "string"
        },
        "refresh": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResponse"
            }
          ]
        },
        "supported": {
          "type": "boolean"
        }
      },
      "required": [
        "observation",
        "applied",
        "change",
        "refresh",
        "supported",
        "connected",
        "canManage",
        "canEnable",
        "canRestartAutomatically"
      ],
      "type": "object"
    },
    "RefreshBackupPolicyBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        }
      },
      "type": "object"
    },
    "RefreshEndpointsBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        }
      },
      "type": "object"
    },
    "RefreshRecoveryPreferencesBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        }
      },
      "type": "object"
    },
    "ReleaseChannelListResponse": {
      "properties": {
        "components": {
          "items": {
            "$ref": "#/$defs/ReleaseComponentResponse"
          },
          "type": "array",
          "description": "One entry per component, always `game`, `oxide` and `carbon` in that order."
        }
      },
      "required": [
        "components"
      ],
      "type": "object",
      "description": "The release channel selection of each component of one server: Rust, Oxide and Carbon."
    },
    "ReleaseChannelResponse": {
      "properties": {
        "buildFlavor": {
          "type": "string",
          "description": "`none`, or for Carbon `release`, `debug` or `minimal`."
        },
        "category": {
          "type": "string",
          "description": "What the channel is for: `stable`, `release`, `staging`, `previous_release`,\n`development`, `debug` or `auxiliary_test`. The same category on two components\ndoes not mean their builds work together. Treat unknown values as other."
        },
        "channel": {
          "type": "string",
          "description": "The RustSC channel name, for example `public` or `production`."
        },
        "gameBranches": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The Rust branches the framework's publisher says this channel's builds are made for (for example `staging`); empty for the game. Shown when the server is on another branch; any combination may still be installed."
        },
        "installable": {
          "type": "boolean",
          "description": "For Oxide and Carbon: true when RustSC installs this channel with this build flavor (the picker's choices), false otherwise. The game's\nbranches change with Change branch and are always false here."
        },
        "platform": {
          "type": "string",
          "description": "`linux-x64` or `windows-x64`."
        },
        "provider": {
          "type": "string",
          "description": "`steam_branch`, `oxide_github`, `oxide_builds` or `carbon_github`. Treat unknown values as other."
        },
        "providerChannel": {
          "type": "string",
          "description": "The provider's own name for the channel: a Steam branch, `latest` for Oxide, or a Carbon release tag."
        },
        "recommended": {
          "type": "boolean",
          "description": "True for the framework's recommended channel (Oxide `public`, Carbon `production`)."
        },
        "selectedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When it was chosen, UTC; null in the list of channels."
        },
        "support": {
          "type": "string",
          "description": "`supported` when RustSC has installed this channel's files on this platform in a real\ntest, otherwise `unverified`. Unverified channels can still be chosen and checked."
        }
      },
      "required": [
        "channel",
        "category",
        "provider",
        "providerChannel",
        "platform",
        "buildFlavor",
        "support",
        "selectedAt"
      ],
      "type": "object",
      "description": "One channel of a component on one platform and build flavor, and where its releases come from."
    },
    "ReleaseComponentResponse": {
      "properties": {
        "channels": {
          "items": {
            "$ref": "#/$defs/ReleaseChannelResponse"
          },
          "type": "array",
          "description": "Every channel, platform and build flavor this component offers, with whether each is supported or unverified."
        },
        "component": {
          "type": "string",
          "description": "`game` (the Rust dedicated server), `oxide` or `carbon`. Treat unknown values as other."
        },
        "discovery": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ReleaseDiscoveryResponse",
              "description": "The release check for the current revision, or null when no channel was chosen."
            }
          ]
        },
        "metadata": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ReleaseMetadataResponse",
              "description": "The newest release information stored for exactly the chosen channel, platform and build\nflavor, or null when none was ever found. It can be older than the last check: see\nbool ReleaseMetadataResponse.Current and its retrieval time."
            }
          ]
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "The selection revision, sent back in `If-Match` as `\"r&lt;revision&gt;\"`; 0 before the first choice."
        },
        "selection": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ReleaseChannelResponse",
              "description": "The chosen channel, or null when none was chosen."
            }
          ]
        }
      },
      "required": [
        "component",
        "revision",
        "selection",
        "discovery",
        "metadata",
        "channels"
      ],
      "type": "object",
      "description": "One component of a server: the channel chosen for it, what the last release check found and\nthe channels that can be chosen. Choosing a channel only checks for releases; it installs\nnothing and changes no files on the server."
    },
    "ReleaseDiscoveryResponse": {
      "properties": {
        "checkedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the provider's answer was read, UTC; null while pending."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why the release is unavailable (`channel_missing`, `password_required`,\n`asset_missing`, `version_unreadable`) or the check failed\n(`source_not_configured`, `provider_unreachable`, `provider_rejected`,\n`response_invalid`); null otherwise. Treat unknown values as other."
        },
        "state": {
          "type": "string",
          "description": "`pending` (not finished yet), `available` (the provider lists a release),\n`unavailable` (the provider has no release for this channel, platform and build\nflavor; another channel is never used instead) or `failed` (the check did not\ncomplete). Treat unknown values as other."
        }
      },
      "required": [
        "state",
        "reason",
        "checkedAt"
      ],
      "type": "object",
      "description": "The release check for the current selection revision."
    },
    "ReleaseMetadataResponse": {
      "properties": {
        "assetBytes": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The package size in bytes, if the provider lists it."
        },
        "assetDigest": {
          "type": [
            "null",
            "string"
          ],
          "description": "The release package identifier when available."
        },
        "assetName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The package file for this platform and build flavor; null for Rust, where Steam selects the files."
        },
        "current": {
          "type": "boolean",
          "description": "True when the last check of the current revision found this release. False when it is\nkept from an earlier check (for example while the provider cannot be reached); it is then\nnot a fresh release check."
        },
        "publishedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the provider published or last updated the release, UTC, if it says."
        },
        "releaseId": {
          "type": "string",
          "description": "The provider's identifier of this exact release (the Steam build ID or the GitHub release ID)."
        },
        "retrievedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When RustSC read this from the provider, UTC."
        },
        "version": {
          "type": "string",
          "description": "The provider's version: a Steam build ID for Rust, or a version such as `2.0.7830` for Oxide and Carbon."
        }
      },
      "required": [
        "version",
        "releaseId",
        "publishedAt",
        "assetName",
        "assetDigest",
        "assetBytes",
        "retrievedAt",
        "current"
      ],
      "type": "object",
      "description": "Release information a provider published for the chosen channel, as RustSC last read it."
    },
    "ReleasePlayerRequestBody": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the player, only so the activity line says it; optional, up to 64 characters."
        },
        "scope": {
          "type": [
            "null",
            "string"
          ],
          "description": "text, voice or freeze. Left out, everything the plugin holds for the player ends."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID of the player, 17 digits."
        }
      },
      "required": [
        "steamId"
      ],
      "type": "object",
      "description": "Ends the mutes and the freeze the plugin holds for a player."
    },
    "RemoveContainerItemsRequestBody": {
      "properties": {
        "generation": {
          "type": "string",
          "description": "The world generation from the listing."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows, only so the activity line says it; optional, up to 64 characters."
        },
        "netId": {
          "type": "string",
          "description": "The network ID of the container, from the listing."
        },
        "revision": {
          "type": "string",
          "description": "The revision from the listing: it names exactly the content that was shown. A container that changed since removes nothing (`revision_changed`)."
        },
        "slot": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The one slot to empty; absent empties every slot."
        }
      },
      "required": [
        "netId",
        "generation",
        "revision"
      ],
      "type": "object",
      "description": "Takes stacks out of one container: one slot, or every stack when no slot is named."
    },
    "RemoveEntityRequestBody": {
      "properties": {
        "generation": {
          "type": "string",
          "description": "The world generation from the inspect."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the thing, only so the activity line says it; optional, up to 64 characters."
        },
        "netId": {
          "type": "string",
          "description": "The network ID from the inspect, as text."
        },
        "revision": {
          "type": "string",
          "description": "The revision from the inspect: it names the entity, its prefab and its owner. A network ID that now names another entity removes nothing (`revision_changed`)."
        }
      },
      "required": [
        "netId",
        "generation",
        "revision"
      ],
      "type": "object",
      "description": "Removes exactly one entity."
    },
    "RemoveGameRoleRequestBody": {
      "properties": {
        "role": {
          "type": "string",
          "description": "The role to take away, `owner` or `moderator`. A Steam ID that holds the other role keeps it."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID, 17 digits."
        }
      },
      "required": [
        "steamId",
        "role"
      ],
      "type": "object",
      "description": "Takes an owner or moderator role away in the game."
    },
    "RemoveHostRequestBody": {
      "properties": {
        "servers": {
          "type": [
            "null",
            "string"
          ],
          "description": "`remove` (the default: the servers leave RustSC too; their files, backups and history are kept) or `keep` (they stay listed as Host removed)."
        },
        "stopServers": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Ignored. The uninstall never stops or interrupts a game (owner answer, 31 October 2026); the field stays so a caller written against revision 232 keeps working."
        },
        "uninstall": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Also uninstall RustSC from the host first. Only while the host is connected and can do it; never assumed."
        }
      },
      "type": "object",
      "description": "Removes a host from RustSC. Nothing on the host is stopped or deleted unless the member also chose to uninstall, and even then no game is stopped."
    },
    "RemoveOwnedEntitiesRequestBody": {
      "properties": {
        "generation": {
          "type": "string",
          "description": "The world generation from the preview."
        },
        "hardCap": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The most entities one removal may take: 1 to 100000, 5000 when left out. A larger set is refused (too_large)."
        },
        "maxDriftPercent": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The most of the set, in whole percent, that may have vanished or changed owner since the preview: 0 to 100, 10 when left out."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the player, only so the activity line says it; optional, up to 64 characters."
        },
        "revision": {
          "type": "string",
          "description": "The revision from the preview."
        },
        "steamId": {
          "type": "string",
          "description": "The owner's Steam ID, 17 digits."
        }
      },
      "required": [
        "steamId",
        "generation",
        "revision"
      ],
      "type": "object",
      "description": "Removes the set a preview captured. It cannot be undone."
    },
    "RemovePlayerItemRequestBody": {
      "properties": {
        "amount": {
          "format": "int32",
          "type": "integer",
          "description": "How many to remove, 1 up to what the stack holds."
        },
        "container": {
          "type": "string",
          "description": "`main`, `belt` or `wear`."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the player, only so the activity line says it; optional."
        },
        "revision": {
          "type": "string",
          "description": "The revision of the inventory read the removal was decided on. Any change to what the player carries since then removes nothing (`revision_changed`)."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID of the player, 17 digits."
        },
        "uid": {
          "type": "string",
          "description": "The item's unique number from that read."
        }
      },
      "required": [
        "steamId",
        "revision",
        "container",
        "uid",
        "amount"
      ],
      "type": "object",
      "description": "Removes an amount of one item from a connected player."
    },
    "RemoveRentedPluginBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "`oxide` or `carbon`, as `getRentedRustscPlugin` read it."
        }
      },
      "type": "object",
      "description": "Remove the RustSC plugin from a rented server (owner decision OA91, 19 November 2026)."
    },
    "RemoveServerRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the server is busy or its host is offline; leave it out to refuse."
            }
          ]
        },
        "stopFirst": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Stop the game gracefully first (needs `servers.lifecycle`). Without it a running game refuses the removal."
        }
      },
      "type": "object",
      "description": "Removes a server from management. Its files are kept."
    },
    "RemovedServerResponse": {
      "properties": {
        "adminState": {
          "type": "string",
          "description": "Always `removed`."
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "id",
        "name",
        "adminState",
        "revision"
      ],
      "type": "object",
      "description": "A server removed at once because no installation routes it (it was detached)."
    },
    "RenameBody": {
      "properties": {
        "name": {
          "type": "string",
          "description": "1 to 100 characters after trimming, no control characters."
        }
      },
      "required": [
        "name"
      ],
      "type": "object",
      "description": "The new RustSC name of a host or a server. It is a label in RustSC only."
    },
    "RenameWorkspaceRequestBody": {
      "properties": {
        "name": {
          "type": "string",
          "description": "The new workspace name members see. Leading and trailing spaces are removed; a new name follows the rules of workspace creation. Sending the present name changes nothing."
        }
      },
      "required": [
        "name"
      ],
      "type": "object",
      "description": "Give the workspace a new name."
    },
    "RenamedResponse": {
      "properties": {
        "changed": {
          "type": "boolean",
          "description": "False when it already had this name; nothing was recorded."
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string",
          "description": "The name now shown everywhere."
        }
      },
      "required": [
        "id",
        "name",
        "changed"
      ],
      "type": "object"
    },
    "RentedBackupLinkResponse": {
      "properties": {
        "expiresAt": {
          "format": "date-time",
          "type": "string"
        },
        "fileName": {
          "type": "string",
          "description": "The name the zip is saved under, such as `My server-2026-11-19-1430-UTC.zip`."
        },
        "sizeBytes": {
          "format": "int64",
          "type": "integer"
        },
        "url": {
          "type": "string"
        }
      },
      "required": [
        "url",
        "expiresAt",
        "fileName",
        "sizeBytes"
      ],
      "type": "object",
      "description": "A link to download a copy RustSC holds for a rented server: for the member who asked, until `expiresAt` (5 minutes)."
    },
    "RentedFrameworkSwitchResponse": {
      "properties": {
        "framework": {
          "type": "string",
          "description": "`oxide`, `carbon` or `none`: the choice that was pressed."
        },
        "state": {
          "type": "string",
          "description": "`applies_at_restart`, `not_offered`, `refused` or `not_confirmed`."
        }
      },
      "required": [
        "state",
        "framework"
      ],
      "type": "object",
      "description": "How a member's Switch of Oxide, Carbon or no framework on a rented server ended."
    },
    "RentedFrameworkUpdateResponse": {
      "properties": {
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "`oxide` or `carbon`; absent when none was read."
        },
        "state": {
          "type": "string",
          "description": "`applies_at_restart`, `not_offered`, `refused` or `not_confirmed`."
        }
      },
      "required": [
        "state"
      ],
      "type": "object",
      "description": "How a member's Update of Oxide or Carbon on a rented server ended."
    },
    "RentedHistoryBody": {
      "properties": {
        "keepHistory": {
          "type": "boolean",
          "description": "True to record the server's processor, memory and players while nobody looks; false to stop."
        }
      },
      "required": [
        "keepHistory"
      ],
      "type": "object"
    },
    "RentedHistoryResponse": {
      "properties": {
        "keepHistory": {
          "type": "boolean"
        }
      },
      "required": [
        "keepHistory"
      ],
      "type": "object"
    },
    "RentedHostActivityEventResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": "string",
          "description": "When the host recorded it."
        },
        "kind": {
          "type": "string",
          "description": "`started`, `stopped`, `restarted`, `killed`, `backup_made`, `backup_restored` or `file_changed`."
        }
      },
      "required": [
        "kind",
        "at"
      ],
      "type": "object",
      "description": "One event at the host."
    },
    "RentedHostActivityResponse": {
      "properties": {
        "events": {
          "items": {
            "$ref": "#/$defs/RentedHostActivityEventResponse"
          },
          "type": "array",
          "description": "Newest first."
        },
        "offered": {
          "type": "boolean",
          "description": "False when the server has no such record; `events` is then empty and no host section is shown."
        },
        "readAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the host was asked for this list; absent when the list was not read from the host."
        }
      },
      "required": [
        "offered",
        "events"
      ],
      "type": "object",
      "description": "The host's own events for a rented server's Activity list."
    },
    "RentedJoinCheckBody": {
      "properties": {
        "enabled": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True to refuse listed players when they join, false to stop. Required."
        }
      },
      "type": "object",
      "description": "The member's switch (`PUT .../servers/{serverId}/ban-lists/join-check`)."
    },
    "RentedJoinCheckResponse": {
      "properties": {
        "available": {
          "type": "boolean",
          "description": "True for a rented server where the switch is offered (or was switched on before); false for every other server, and nothing else is meaningful then."
        },
        "checkedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When RustSC last confirmed the server's setting; null when it could not."
        },
        "enabled": {
          "type": "boolean",
          "description": "The saved choice."
        },
        "enforced": {
          "type": "boolean",
          "description": "True when the workspace enforces at least one ban list, so switching on has an effect."
        },
        "keptAfterRestart": {
          "type": "boolean",
          "description": "True when a restart of the server keeps it; false means switch it off and on again after a restart."
        },
        "state": {
          "type": "string",
          "description": "One of off, on, not_confirmed, other_service or not_set."
        },
        "words": {
          "type": "string",
          "description": "The sentence to show for the state; empty when off."
        }
      },
      "required": [
        "available",
        "enabled",
        "state",
        "enforced",
        "words",
        "keptAfterRestart"
      ],
      "type": "object",
      "description": "Whether a rented server refuses listed players when they join."
    },
    "RentedPluginResponse": {
      "properties": {
        "connected": {
          "type": "boolean",
          "description": "False when the server has no rented connection whose files RustSC may list, read and write; the other members are then empty."
        },
        "current": {
          "type": "boolean",
          "description": "True when that file is exactly the copy RustSC carries now."
        },
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "`oxide` or `carbon`; null when neither is installed."
        },
        "frameworkSwitch": {
          "type": [
            "null",
            "string"
          ],
          "description": "Only with `framework_missing`: the host's startup setting that turns Oxide or Carbon on (for example `OXIDE`), when the host keeps one."
        },
        "installed": {
          "type": "boolean",
          "description": "True when the plugin file is in the framework's plugin folder."
        },
        "readAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When this answer was read from the server's files; absent when nothing was read."
        },
        "reason": {
          "type": "string",
          "description": "Empty when the files were read; otherwise why not: `framework_missing`, or the file route's reason."
        }
      },
      "required": [
        "connected",
        "installed",
        "current",
        "reason"
      ],
      "type": "object",
      "description": "What a rented server's files say about the RustSC plugin."
    },
    "RentedQueryAddressBody": {
      "properties": {
        "address": {
          "type": [
            "null",
            "string"
          ],
          "description": "A public IPv4 address, or null to clear the saved one."
        },
        "port": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The query port, 1024 to 65535."
        }
      },
      "type": "object"
    },
    "RentedQueryAddressResponse": {
      "properties": {
        "queryAddress": {
          "type": [
            "null",
            "string"
          ]
        },
        "queryPort": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        }
      },
      "type": "object"
    },
    "RentedRustEditResponse": {
      "properties": {
        "available": {
          "type": [
            "null",
            "string"
          ],
          "description": "The newest listed build; absent when none is listed."
        },
        "availableLabel": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/BuildLabelResponse",
              "description": "The release name or day of the newest listed build, when known."
            }
          ]
        },
        "comparison": {
          "type": "string",
          "description": "`current`, `update_available` or `unknown`."
        },
        "installable": {
          "type": "boolean",
          "description": "True when RustEdit can be installed or updated on this server from here (`changeExtension`); false hides the action."
        },
        "installed": {
          "type": "boolean",
          "description": "True when the extension's file is on the server."
        },
        "version": {
          "type": [
            "null",
            "string"
          ],
          "description": "The installed build; absent when not installed or not read."
        },
        "versionLabel": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/BuildLabelResponse",
              "description": "The release name or day of the installed build, when known."
            }
          ]
        }
      },
      "required": [
        "installed",
        "comparison"
      ],
      "type": "object",
      "description": "RustEdit on a rented server: whether its file is there, its build and the newest listed build, with their names when known."
    },
    "RentedSoftwareResponse": {
      "properties": {
        "connected": {
          "type": "boolean",
          "description": "False when the server has no rented connection; the other members are then empty."
        },
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "`oxide` or `carbon`; absent when neither is installed or the files could not be read."
        },
        "frameworkAvailable": {
          "type": [
            "null",
            "string"
          ],
          "description": "The newest production release of that framework from the shared listing; absent when none is listed."
        },
        "frameworkChoices": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The frameworks the member may switch this server to on the host's own route (`oxide`, `carbon`, `none`, never the one shown); empty hides Switch."
        },
        "frameworkComparison": {
          "type": "string",
          "description": "`current`, `update_available` or `unknown`."
        },
        "frameworkSwitch": {
          "type": [
            "null",
            "string"
          ],
          "description": "Only with `framework_missing`: the host's startup setting that turns Oxide or Carbon on (for example `OXIDE`), when the host keeps one."
        },
        "frameworkUpdatable": {
          "type": "boolean",
          "description": "True only when an update is listed and the host has a route for it, so the Update action may be shown; false hides it."
        },
        "frameworkVersion": {
          "type": [
            "null",
            "string"
          ],
          "description": "The framework's version from its own console command; absent when the console did not answer."
        },
        "gameBuiltOn": {
          "type": [
            "null",
            "string"
          ],
          "description": "The date the game build was made (`yyyy-MM-dd`); absent when not read."
        },
        "gameVersion": {
          "type": [
            "null",
            "string"
          ],
          "description": "The game's own version (its protocol, for example `2636.290.1`); absent when the console did not answer."
        },
        "readAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When this answer was read from the server; absent when nothing was read."
        },
        "reason": {
          "type": "string",
          "description": "Empty when the files were read; otherwise why not: `framework_missing`, or the file route's reason."
        },
        "rustEdit": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/RentedRustEditResponse",
              "description": "RustEdit's extension as the server's files show it; absent when the files could not say."
            }
          ]
        }
      },
      "required": [
        "connected",
        "frameworkComparison",
        "reason"
      ],
      "type": "object",
      "description": "The game and framework versions of a rented server, read from its console and its files. A value that could not be read is absent, never a guess."
    },
    "RentedStartAgainResponse": {
      "properties": {
        "changedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the choice was last saved; absent until it was."
        },
        "held": {
          "type": "boolean",
          "description": "True while RustSC has stopped trying after 3 starts in 30 minutes."
        },
        "offered": {
          "type": "boolean",
          "description": "False where the host has no start RustSC can use or the server has no saved query address: the setting is not shown."
        },
        "on": {
          "type": "boolean"
        }
      },
      "required": [
        "on",
        "offered",
        "held"
      ],
      "type": "object"
    },
    "RentedStatusResponse": {
      "properties": {
        "build": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The game's own build number from its console; absent when the console did not say."
        },
        "framerate": {
          "format": "double",
          "type": [
            "null",
            "number"
          ]
        },
        "framerateBand": {
          "type": [
            "null",
            "string"
          ],
          "description": "good, slow or poor for the framerate; absent when there is none. The same bands as a full host's frame rate."
        },
        "gameAddress": {
          "type": [
            "null",
            "string"
          ],
          "description": "The address players type into the game, as the host's own server details give it; absent when the host does not say."
        },
        "gamePort": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The game's port that goes with the game address; absent when the host does not say."
        },
        "map": {
          "type": [
            "null",
            "string"
          ]
        },
        "maxPlayers": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "nextRestartAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The time of the soonest restart the member saved that is still waiting; absent when none. Read from what the member saved."
        },
        "players": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "power": {
          "type": [
            "null",
            "string"
          ],
          "description": "running or stopped, from the host's own word; absent when the host cannot say. A game that answers is running."
        },
        "queryAddress": {
          "type": [
            "null",
            "string"
          ],
          "description": "The public IPv4 address the member entered for their own server; absent when none."
        },
        "queryFoundBy": {
          "type": [
            "null",
            "string"
          ],
          "description": "The host's name when the saved address was found by the host and not typed by the member; absent otherwise."
        },
        "queryPort": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "queued": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "readAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the game answered, or when the read ended with no answer."
        },
        "route": {
          "type": [
            "null",
            "string"
          ],
          "description": "console or query; absent unless answering."
        },
        "state": {
          "type": "string",
          "description": "answering, not_answering or not_set."
        },
        "uptimeSeconds": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ]
        }
      },
      "required": [
        "state",
        "readAt"
      ],
      "type": "object"
    },
    "ReplaceServerRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the host is busy or offline; leave it out to refuse."
            }
          ]
        },
        "hostId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The host that holds the new game (`hst_` ID); leave it out for the server's own host."
        },
        "installFramework": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Step 2: install the framework the server had. Default true."
        },
        "installGame": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Step 1: install the game server. Untick when the new host already has the game files. Default true."
        },
        "installPlugins": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Step 3: install the plugins that can be downloaded from uMod. Default true."
        },
        "installRustscPlugin": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Step 3, continued: install the RustSC plugin after the framework (needs the framework step and a framework the server had). Default false: the form pre-ticks it, a request that does not name it installs nothing new."
        },
        "ports": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ServerPortsBody",
              "description": "The new game's ports; leave it out to keep the ports the old game was set up with."
            }
          ]
        },
        "pushConfiguration": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Step 4: push the saved settings (server.cfg values, launch arguments, world settings, ports, schedules). Default true."
        },
        "restoreFromCloud": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Step 5, the safety override: download the cloud copy of the backup even when the host holds an intact copy of it. Leave it out (false) for the normal order: the host's own copy when it is there and whole, the cloud copy of the same backup only when it is not. Ignored without `restoreRecoveryPointId`."
        },
        "restoreRecoveryPointId": {
          "type": [
            "null",
            "string"
          ]
        },
        "root": {
          "type": [
            "null",
            "string"
          ],
          "description": "The game folder on that host; leave it out to keep the folder the server has."
        }
      },
      "type": "object",
      "description": "Replaces a server's game with a new one and pushes what the portal holds for it. The two ticks are the only choices and both\ndefault to true (leave them out for the default)."
    },
    "ReplaceServerResponse": {
      "properties": {
        "install": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResponse",
              "description": "The installation operation, when requested."
            }
          ]
        },
        "push": {
          "$ref": "#/$defs/ReplacementPushResponse"
        },
        "steps": {
          "items": {
            "$ref": "#/$defs/ReplacementStepResponse"
          },
          "type": "array",
          "description": "Every step in the order it runs, each with its own operation to follow."
        }
      },
      "required": [
        "steps",
        "push"
      ],
      "type": "object",
      "description": "The answer to replacing a server: the install operation and what is pushed behind it."
    },
    "ReplacementBackupResponse": {
      "properties": {
        "bytes": {
          "format": "int64",
          "type": "integer"
        },
        "complete": {
          "type": "boolean",
          "description": "True when the backup was checked complete when it was uploaded; the form proposes the newest such backup."
        },
        "recoveryPointId": {
          "type": "string"
        },
        "takenAt": {
          "format": "date-time",
          "type": "string"
        },
        "where": {
          "type": "string",
          "description": "Where it is kept: `host`, `cloud` or `both`. A backup kept only on the host is offered when the new place is the host the server was on (it has no cloud copy, so it is restored from the host as it is)."
        }
      },
      "required": [
        "recoveryPointId",
        "takenAt",
        "bytes",
        "complete"
      ],
      "type": "object",
      "description": "A backup the form can offer: one kept on the host, in cloud storage or both, by time."
    },
    "ReplacementItemResponse": {
      "properties": {
        "area": {
          "type": "string",
          "description": "`settings`, `framework`, `plugins`, `plugin_files`."
        },
        "count": {
          "format": "int32",
          "type": "integer"
        },
        "text": {
          "type": "string",
          "description": "The sentence to show."
        }
      },
      "required": [
        "area",
        "count",
        "text"
      ],
      "type": "object",
      "description": "One line of what is and is not pushed."
    },
    "ReplacementPlanResponse": {
      "properties": {
        "backups": {
          "items": {
            "$ref": "#/$defs/ReplacementBackupResponse"
          },
          "type": "array",
          "description": "The cloud backups that could be brought onto the new host, newest first."
        },
        "hostId": {
          "type": "string"
        },
        "platform": {
          "type": "string"
        },
        "portConflicts": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "One plain line per port another server on that host already uses."
        },
        "ports": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ServerPortsBody",
              "description": "The ports the new game would use; null when none were recorded (the conventional ones are used)."
            }
          ]
        },
        "push": {
          "$ref": "#/$defs/ReplacementPushResponse"
        },
        "root": {
          "type": "string"
        }
      },
      "required": [
        "hostId",
        "root",
        "platform",
        "portConflicts",
        "push",
        "backups"
      ],
      "type": "object",
      "description": "What the Replace form shows before it is submitted."
    },
    "ReplacementPushResponse": {
      "properties": {
        "notPushed": {
          "items": {
            "$ref": "#/$defs/ReplacementItemResponse"
          },
          "type": "array"
        },
        "pushed": {
          "items": {
            "$ref": "#/$defs/ReplacementItemResponse"
          },
          "type": "array"
        },
        "summary": {
          "type": "string",
          "description": "One line: \"Copied: 12 settings, 3 plugins. Not copied: ...\"."
        }
      },
      "required": [
        "pushed",
        "notPushed",
        "summary"
      ],
      "type": "object",
      "description": "What is pushed and what is not, with the reason."
    },
    "ReplacementStepResponse": {
      "properties": {
        "operationId": {
          "type": "string"
        },
        "step": {
          "type": "string",
          "description": "`game`, `framework`, `plugins`, `backup` or `settings`."
        }
      },
      "required": [
        "step",
        "operationId"
      ],
      "type": "object",
      "description": "One step and its operation."
    },
    "ReportChangeBody": {
      "properties": {
        "assignee": {
          "type": [
            "null",
            "string"
          ],
          "description": "`me` assigns the report to the caller, `none` removes the assignment."
        },
        "moderation": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ReportModerationBody",
              "description": "Records that the caller asked for a kick or ban of the reported player, which they did through the player actions. RustSC does not send it from here."
            }
          ]
        },
        "note": {
          "type": [
            "null",
            "string"
          ],
          "description": "A note for the staff, up to 2000 characters. The player never sees it."
        },
        "status": {
          "type": [
            "null",
            "string"
          ],
          "description": "`open`, `investigating`, `resolved` or `dismissed`. Moving a closed report back to `open` reopens it."
        },
        "unread": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True marks the report unread, false marks it read."
        }
      },
      "type": "object",
      "description": "The parts of a change to a report; set at least one."
    },
    "ReportDetailResponse": {
      "properties": {
        "history": {
          "items": {
            "$ref": "#/$defs/ReportHistoryResponse"
          },
          "type": "array"
        },
        "report": {
          "$ref": "#/$defs/ReportResponse"
        }
      },
      "required": [
        "report",
        "history"
      ],
      "type": "object",
      "description": "A report with its history, oldest first."
    },
    "ReportEvidenceResponse": {
      "properties": {
        "from": {
          "format": "date-time",
          "type": "string",
          "description": "The window: five minutes before the report to five minutes after it."
        },
        "gaps": {
          "items": {
            "$ref": "#/$defs/EvidenceGapResponse"
          },
          "type": "array",
          "description": "Stretches of the window that were not recorded."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/EvidenceItemResponse"
          },
          "type": "array",
          "description": "Oldest first. Report text is never in here."
        },
        "kept": {
          "type": "boolean",
          "description": "False once the events of that time are older than the evidence is kept."
        },
        "more": {
          "type": "boolean",
          "description": "True when more events than were returned fall in the window; Find events lists them."
        },
        "readable": {
          "type": "boolean",
          "description": "False when the caller may read the report but not the server's events, or this cloud keeps no evidence; nothing else is then given."
        },
        "retentionDays": {
          "format": "int32",
          "type": "integer",
          "description": "How many days events are kept."
        },
        "until": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "readable",
        "kept",
        "from",
        "until",
        "items",
        "more",
        "gaps",
        "retentionDays"
      ],
      "type": "object",
      "description": "What a server recorded around the time a report was sent."
    },
    "ReportHistoryResponse": {
      "properties": {
        "action": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a `moderation` item, what was asked for: `kick` or `ban`; otherwise null."
        },
        "at": {
          "format": "date-time",
          "type": "string"
        },
        "by": {
          "type": "string",
          "description": "`me`, `teammate` or `rustsc`."
        },
        "byName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name of the member who did it (their chat name in this workspace, else their Discord name), or null for RustSC or a member without a name; the portal then says \"Another member\"."
        },
        "from": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a status change, the status before; otherwise null."
        },
        "kind": {
          "type": "string",
          "description": "`received`, `status`, `assigned`, `unassigned`, `read`, `unread`, `note` or `moderation`."
        },
        "note": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a note, the staff's text; otherwise null."
        },
        "operationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a `moderation` item, the operation that carries it out; read it for the result. Otherwise null."
        },
        "operationState": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a `moderation` item, where that operation is now (`queued`, `running`, `succeeded`, `failed` and so on); null when it cannot be read. The report's status never says whether the action worked."
        },
        "to": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a status change, the status after; otherwise null."
        }
      },
      "required": [
        "kind",
        "by",
        "at",
        "from",
        "to",
        "note"
      ],
      "type": "object",
      "description": "One thing that happened to a report."
    },
    "ReportModerationBody": {
      "properties": {
        "action": {
          "type": "string",
          "description": "`kick` or `ban`."
        },
        "operationId": {
          "type": "string",
          "description": "The operation that kickPlayer or banPlayer returned, on the same server as the report."
        }
      },
      "required": [
        "action",
        "operationId"
      ],
      "type": "object",
      "description": "A kick or ban the caller already asked for, to record on the report."
    },
    "ReportResponse": {
      "properties": {
        "assignedTo": {
          "type": "string",
          "description": "`none`, `me` (the caller) or `teammate`."
        },
        "assignedToName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name of the member who picked the report up (their chat name in this workspace, else their Discord name), or null when it is not picked up or the member has no name; the portal then says \"Another member\"."
        },
        "canManage": {
          "type": "boolean",
          "description": "True when the caller may change this report (`reports.manage` on its server)."
        },
        "id": {
          "type": "string"
        },
        "kind": {
          "type": "string",
          "description": "`player_report` (it accuses a player) or `feedback`."
        },
        "lastActivityAt": {
          "format": "date-time",
          "type": "string",
          "description": "The last submission, status change or note."
        },
        "message": {
          "type": [
            "null",
            "string"
          ]
        },
        "occurredAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the player sent it."
        },
        "receivedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When RustSC received it."
        },
        "reportType": {
          "type": [
            "null",
            "string"
          ],
          "description": "The game's own type word of a player report (for example `Cheat`), or null."
        },
        "reporterName": {
          "type": [
            "null",
            "string"
          ]
        },
        "reporterSteamId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The reporting player's Steam ID, as the game authenticated it, or null."
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "The revision a change names in `If-Match`; also the ETag."
        },
        "serverId": {
          "type": "string"
        },
        "serverName": {
          "type": "string",
          "description": "The server's name now."
        },
        "status": {
          "type": "string",
          "description": "`open`, `investigating`, `resolved` or `dismissed`."
        },
        "subject": {
          "type": [
            "null",
            "string"
          ]
        },
        "targetName": {
          "type": [
            "null",
            "string"
          ]
        },
        "targetSteamId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The reported player's Steam ID, or null when the report named none."
        },
        "unread": {
          "type": "boolean",
          "description": "True until someone on the staff marks it read. Shared by the staff."
        }
      },
      "required": [
        "id",
        "serverId",
        "serverName",
        "kind",
        "reportType",
        "subject",
        "message",
        "reporterSteamId",
        "reporterName",
        "targetSteamId",
        "targetName",
        "occurredAt",
        "receivedAt",
        "status",
        "assignedTo",
        "unread",
        "revision",
        "lastActivityAt",
        "canManage"
      ],
      "type": "object",
      "description": "One F7 report or piece of feedback a player sent from the game. Names, subject and message are the player's own text: show them as text, never as markup or a command."
    },
    "ReportsPageResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/ReportResponse"
          },
          "type": "array"
        },
        "next": {
          "type": [
            "null",
            "string"
          ],
          "description": "Pass as `before` to read the next page; null on the last page."
        },
        "openCount": {
          "format": "int32",
          "type": "integer",
          "description": "Reports still to work on (open or investigating) on every server the caller may read, whatever the filter."
        },
        "unreadCount": {
          "format": "int32",
          "type": "integer",
          "description": "Unread reports on the same servers."
        }
      },
      "required": [
        "items",
        "next",
        "openCount",
        "unreadCount"
      ],
      "type": "object",
      "description": "One page of the report inbox, newest activity first."
    },
    "RequestPermissionSyncBody": {
      "properties": {
        "action": {
          "type": "string"
        },
        "key": {
          "type": [
            "null",
            "string"
          ]
        },
        "scope": {
          "type": [
            "null",
            "string"
          ]
        },
        "serverId": {
          "type": [
            "null",
            "string"
          ]
        },
        "servers": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ]
        }
      },
      "required": [
        "action"
      ],
      "type": "object",
      "description": "Asks for something that needs a host (`requestPermissionSync`): `preview` (what turning the sync on for `servers` would do), `check` (a pass now),\n`resume_preview` (what a resume would send), `resume` (resume, then send one batch) or `check_starting` (read one server again for how it hands out its starting group; give its\n`serverId`). For a resume give `scope` (`item`, `server` or `set`) and its `key` or `serverId`."
    },
    "ResolveMissingGroupBody": {
      "properties": {
        "action": {
          "type": "string"
        },
        "group": {
          "type": "string"
        },
        "serverId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The server the group vanished from; required for `make_again`."
        }
      },
      "required": [
        "action",
        "group"
      ],
      "type": "object",
      "description": "What the member chooses for a group that vanished from a server (`resolveMissingPermissionGroup`): `make_again` (create it again on `serverId`) or `delete_everywhere`."
    },
    "ResourceAlertListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/ResourceAlertResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object"
    },
    "ResourceAlertResponse": {
      "properties": {
        "acknowledged": {
          "type": "boolean"
        },
        "hostId": {
          "type": [
            "null",
            "string"
          ]
        },
        "id": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "nextStep": {
          "type": [
            "null",
            "string"
          ]
        },
        "rule": {
          "type": "string",
          "description": "One of `disk_low`, `disk_full`, `volume_read_only`, `cpu_high`, `memory_high`, `disk_queue_high`, `server_low_fps`."
        },
        "scope": {
          "type": "string",
          "description": "`host` for the host or one of its volumes, `server` for one server's own use."
        },
        "serverId": {
          "type": [
            "null",
            "string"
          ]
        },
        "serverName": {
          "type": [
            "null",
            "string"
          ]
        },
        "severity": {
          "type": "string"
        },
        "since": {
          "format": "date-time",
          "type": "string"
        },
        "volume": {
          "type": [
            "null",
            "string"
          ],
          "description": "The disk the alert is about, for `disk_low`, `disk_full` and `volume_read_only`."
        },
        "volumeServers": {
          "items": {
            "$ref": "#/$defs/ResourceAlertVolumeServerResponse"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "For `disk_low` and `disk_full`: the servers whose folders are on the disk, so the portal can link Free up space and the file manager to them. Absent for every other alert."
        }
      },
      "required": [
        "id",
        "rule",
        "scope",
        "severity",
        "acknowledged",
        "since",
        "message"
      ],
      "type": "object",
      "description": "An open resource alert with its plain-words message and, for low disk space, the one next step."
    },
    "ResourceAlertVolumeServerResponse": {
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object",
      "description": "A server that keeps files on the disk of an alert."
    },
    "RestartHostRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the host is busy or offline; leave it out to refuse."
            }
          ]
        },
        "warningMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Minutes of player warning before the servers stop, 0 to 60; absent means the default of 5."
        }
      },
      "type": "object",
      "description": "Restarts a host's operating system now; players are warned first."
    },
    "RestartPermissionsBody": {
      "properties": {
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "`oxide` or `carbon`."
        },
        "operations": {
          "items": {
            "$ref": "#/$defs/PlayerPermissionOperationBody"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The changes, in order (at most 500)."
        }
      },
      "type": "object",
      "description": "Player permission changes a restart applies while the game is stopped."
    },
    "RestoreBackupRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "planSha256": {
          "type": [
            "null",
            "string"
          ],
          "description": "The planSha256 of the preview the member confirmed."
        },
        "putBackOf": {
          "type": [
            "null",
            "string"
          ],
          "description": "The id of the failed start that stopped the game because it came back on another world and waits for the member's OK. Set, the restore is that start's backup put back\n(\"Put the world back\"); planSha256 is then not needed. Absent for every other restore."
        },
        "start": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Start the server after its files are restored. Absent means false (off)."
        },
        "warningMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Minutes of player warning before the server stops, from 0 to the longest warning (60); players\nsee a countdown in chat. Absent means the normal warning of 5 minutes; 0 stops at once."
        }
      },
      "type": "object"
    },
    "RestoreOffsiteBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "restoreFromCloud": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "The safety override: download the cloud copy even when the host holds a whole copy of the same backup. Leave it out (false) for the normal order: the host's own copy when it is there and whole, the cloud copy of the same backup when it is not."
        }
      },
      "type": "object",
      "description": "Restore one cloud copy onto the server's replacement host."
    },
    "RestoreOverBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "sourceServerId": {
          "type": [
            "null",
            "string"
          ]
        },
        "targetName": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object",
      "description": "Restore a whole backup of another server over this one: the server that owns the backup, and the name of this server typed as the one confirmation. Nothing else can be\nnamed: not a file, not a part."
    },
    "RestorePlayerBlueprintsRequestBody": {
      "properties": {
        "items": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Item short names, at most 2000; empty means no learned blueprint. Normally the before list of an earlier unlock."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the player, only so the activity line says it; optional, up to 64 characters."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID of the player, 17 digits."
        }
      },
      "required": [
        "steamId",
        "items"
      ],
      "type": "object",
      "description": "Makes a connected player's learned blueprints exactly this list."
    },
    "RestoreToFolderBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "folder": {
          "type": [
            "null",
            "string"
          ],
          "description": "A folder on the server's host. Only its last folder is made."
        }
      },
      "type": "object",
      "description": "Restore a whole backup to a folder: where (absent: the default restored-backups area) and the optional admission choices. No file or part can be named."
    },
    "RevokePlayerLinkBody": {
      "properties": {
        "erase": {
          "type": "boolean",
          "description": "Accepted and ignored. Before 26 October 2026 true also deleted the kept history of the person; now every unlink deletes the link and everything kept for it."
        }
      },
      "type": "object"
    },
    "RoadmapItemResponse": {
      "properties": {
        "id": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "description": "`considering`, `planned`, `in_progress` or `shipped`."
        },
        "summary": {
          "type": [
            "null",
            "string"
          ]
        },
        "title": {
          "type": "string"
        },
        "voted": {
          "type": "boolean",
          "description": "Whether the asking account voted; always false on the public read."
        },
        "votes": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "id",
        "title",
        "status",
        "votes",
        "voted"
      ],
      "type": "object",
      "description": "A roadmap item with the number of accounts that voted."
    },
    "RoadmapResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/RoadmapItemResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object"
    },
    "RoleAssignmentResponse": {
      "properties": {
        "roleId": {
          "type": "string",
          "description": "Role ID, for example `role_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "scopeId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The server group or server ID for a narrower scope; null at workspace scope."
        },
        "scopeKind": {
          "type": "string",
          "description": "`workspace`, `server_group`, `server` or `host`. Treat unknown values as other."
        }
      },
      "required": [
        "roleId",
        "scopeKind",
        "scopeId"
      ],
      "type": "object",
      "description": "One role assigned to a member at one scope."
    },
    "RoleBenefitResponse": {
      "properties": {
        "alreadyHad": {
          "format": "int32",
          "type": "integer",
          "description": "Players who already had the role: it is theirs and is never taken back."
        },
        "cannotConfirmSince": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "given": {
          "format": "int32",
          "type": "integer",
          "description": "Players RustSC gave the role to."
        },
        "graceHours": {
          "format": "int32",
          "type": "integer"
        },
        "id": {
          "type": "string"
        },
        "problem": {
          "type": [
            "null",
            "string"
          ]
        },
        "removedOutside": {
          "format": "int32",
          "type": "integer",
          "description": "Players whose role staff took away: not given again until eligibility changes or Reapply."
        },
        "removing": {
          "type": "boolean"
        },
        "roleId": {
          "type": "string"
        },
        "roleName": {
          "type": "string"
        },
        "rustGroups": {
          "items": {
            "$ref": "#/$defs/LinkedGroupResponse"
          },
          "type": "array",
          "description": "The Rust groups this rule also adds linked players to, one per server (only a `linked` rule has any)."
        },
        "source": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "source",
        "roleId",
        "roleName",
        "graceHours",
        "removing",
        "given",
        "alreadyHad",
        "removedOutside",
        "rustGroups"
      ],
      "type": "object",
      "description": "One rule. `source` is `linked` or `boosting`. `problem` is why the role cannot be given right now: `no_permission` (the bot lacks Manage Roles),\n`role_above` (the role is not below the bot's), `role_missing`, `role_unavailable` or `role_powerful`; null when it works. `removing` is true while\nroles are being taken back before the rule goes. `cannotConfirmSince` is set while Discord has not answered about someone this rule covers; nothing is taken away then."
    },
    "RoleBenefitsResponse": {
      "properties": {
        "available": {
          "type": "boolean"
        },
        "benefits": {
          "items": {
            "$ref": "#/$defs/RoleBenefitResponse"
          },
          "type": "array"
        },
        "defaultGraceHours": {
          "format": "int32",
          "type": "integer",
          "description": "The grace used when a rule does not set one, in hours."
        },
        "limit": {
          "format": "int32",
          "type": "integer",
          "description": "The most rules a workspace may have."
        },
        "waiting": {
          "format": "int32",
          "type": "integer",
          "description": "Linked players the sync has not looked at yet (a backlog is worked through a few at a time)."
        }
      },
      "required": [
        "available",
        "benefits",
        "waiting",
        "limit",
        "defaultGraceHours"
      ],
      "type": "object",
      "description": "The role benefits of a workspace: \"linked players get this Discord role\". `available` is false\nwhile no Discord server is connected."
    },
    "RoleBody": {
      "properties": {
        "name": {
          "type": "string",
          "description": "The name members see. Leading and trailing spaces are removed; a new name is 1 to 64 characters with no line breaks or hidden characters (else `too_long` or `control_character`); the role's present name is kept as it is."
        },
        "permissions": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The permission names the role holds, at least one. You can give only permissions you hold yourself. Sending the present set changes nothing."
        }
      },
      "required": [
        "name",
        "permissions"
      ],
      "type": "object",
      "description": "A custom role: its name and the whole of its permissions."
    },
    "RoleListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/RoleResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "Always null: the list is returned in one page."
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The number of items."
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount"
      ],
      "type": "object",
      "description": "The roles of the workspace: the presets first, then custom roles by name."
    },
    "RoleResponse": {
      "properties": {
        "adminLevel": {
          "type": "boolean",
          "description": "Such a role is given for the whole workspace only."
        },
        "id": {
          "type": "string",
          "description": "Role ID, for example `role_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "name": {
          "type": "string",
          "description": "The name members see, for example `Operator`."
        },
        "permissions": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The permissions the role holds, as permission names in catalog order (see the permissions list). A preset's come from RustSC."
        },
        "preset": {
          "type": [
            "null",
            "string"
          ],
          "description": "`owner`, `administrator`, `operator`, `moderator` or `viewer` for a preset; null for a custom role. Treat unknown values as other."
        },
        "serverScopable": {
          "type": "boolean",
          "description": "True when the role can be given on specific servers: it is not admin-level and holds at least one permission that applies to a server."
        }
      },
      "required": [
        "id",
        "name",
        "preset",
        "adminLevel",
        "serverScopable",
        "permissions"
      ],
      "type": "object",
      "description": "A role of the workspace, a preset or a custom role."
    },
    "RoleSyncChoicesResponse": {
      "properties": {
        "botCanManageRoles": {
          "type": "boolean"
        },
        "groups": {
          "items": {
            "$ref": "#/$defs/RoleSyncGroupResponse"
          },
          "type": "array"
        },
        "groupsRead": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "False when the groups could not be read now; absent in answers from before this field existed."
        },
        "roles": {
          "items": {
            "$ref": "#/$defs/BenefitRoleResponse"
          },
          "type": "array"
        },
        "servers": {
          "items": {
            "$ref": "#/$defs/RoleSyncServerResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "roles",
        "servers",
        "groups",
        "botCanManageRoles"
      ],
      "type": "object",
      "description": "What a sync can be made from: the Discord roles (with `problem` as on a benefit), the servers and the groups (`staff` means an Owner must allow it): those of the chosen server, or with no server chosen the groups every server has. `groupsRead` is false when a server did not answer, and then `groups` is empty."
    },
    "RoleSyncGroupResponse": {
      "properties": {
        "name": {
          "type": "string"
        },
        "staff": {
          "type": "boolean"
        }
      },
      "required": [
        "name",
        "staff"
      ],
      "type": "object"
    },
    "RoleSyncResponse": {
      "properties": {
        "appliedByDirection": {
          "format": "int32",
          "type": "integer"
        },
        "cannotConfirmSince": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "direction": {
          "type": "string"
        },
        "discordWon": {
          "format": "int32",
          "type": "integer",
          "description": "How many times a both-ways sync found both sides changed and the newest change won. Newest is when RustSC first saw each change: `discordWon` when it learned of Discord's change last,\n`rustWon` when it learned of the game's last, `appliedByDirection` when it first saw both in the same read and the tie rule applied (Discord's side is copied)."
        },
        "graceHours": {
          "format": "int32",
          "type": "integer"
        },
        "group": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "problem": {
          "type": [
            "null",
            "string"
          ]
        },
        "removeWhenLost": {
          "type": "boolean"
        },
        "removedOutside": {
          "format": "int32",
          "type": "integer"
        },
        "removing": {
          "type": "boolean"
        },
        "roleId": {
          "type": "string"
        },
        "roleName": {
          "type": "string"
        },
        "rustWon": {
          "format": "int32",
          "type": "integer"
        },
        "sameOnBothSides": {
          "format": "int32",
          "type": "integer"
        },
        "serverId": {
          "type": [
            "null",
            "string"
          ]
        },
        "serverName": {
          "type": [
            "null",
            "string"
          ]
        },
        "staffAllowed": {
          "type": "boolean",
          "description": "An Owner allowed this sync to write to a staff group."
        },
        "takeOver": {
          "type": "boolean"
        },
        "waiting": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "id",
        "roleId",
        "roleName",
        "group",
        "direction",
        "removeWhenLost",
        "takeOver",
        "graceHours",
        "staffAllowed",
        "removing",
        "discordWon",
        "rustWon",
        "appliedByDirection",
        "sameOnBothSides",
        "removedOutside",
        "waiting"
      ],
      "type": "object",
      "description": "One sync. `direction` is `discord_to_rust`, `rust_to_discord` or `both`. `serverId` is null for every server (one-way syncs only); `serverName` is what to show. `problem` is why the sync cannot work now: `author_lost` (the member who made it no longer holds roles.sync.manage), `group_is_staff`, `group_missing`, `no_permission`, `role_above`, `role_missing`, `role_unavailable` or `role_powerful`. `cannotConfirmSince` is set while a side has not answered; nothing is changed then. `sameOnBothSides` counts linked players who have both the role and the group;\n`removedOutside` counts players whose entry staff took away (not given again until Give again); `waiting` counts linked players not compared yet."
    },
    "RoleSyncServerResponse": {
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "RoleSyncsResponse": {
      "properties": {
        "available": {
          "type": "boolean"
        },
        "defaultGraceHours": {
          "format": "int32",
          "type": "integer",
          "description": "The grace used when a sync does not set one, in hours."
        },
        "limit": {
          "format": "int32",
          "type": "integer",
          "description": "The most syncs a workspace may have."
        },
        "rustConnected": {
          "type": "boolean"
        },
        "syncs": {
          "items": {
            "$ref": "#/$defs/RoleSyncResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "available",
        "rustConnected",
        "syncs",
        "limit",
        "defaultGraceHours"
      ],
      "type": "object",
      "description": "The role syncs of a workspace: a Discord role and a Rust group kept in step for linked players. `available` is false while no Discord\nserver is connected; `rustConnected` is false while this deployment cannot read or change a server's groups, and then no sync can be made and nothing changes."
    },
    "RollPluginRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "direction": {
          "type": [
            "null",
            "string"
          ],
          "description": "`back` puts the file the update replaced back; `forward` applies the update again after a roll back."
        }
      },
      "type": "object",
      "description": "Roll the last update of a plugin file back, or forward again (within 48 hours of the update)."
    },
    "RotationBody": {
      "properties": {
        "afterLast": {
          "type": [
            "null",
            "string"
          ],
          "description": "After the last map: `again` starts the list over (the default), `random` makes every later wipe a new random map."
        },
        "entries": {
          "items": {
            "$ref": "#/$defs/RotationEntryBody"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The maps in order, one to 50."
        }
      },
      "type": "object",
      "description": "A rotation of maps: one map per wipe, in order. Not together with `level`, `levelUrl`, `seed`, `worldSize`, `keepMap` or `mapName`."
    },
    "RotationEntryBody": {
      "properties": {
        "id": {
          "type": "string",
          "description": "The entry's own ID, 4 to 32 lowercase letters and digits, unique in the list; reordering keeps the place in the rotation."
        },
        "level": {
          "type": [
            "null",
            "string"
          ],
          "description": "`Procedural Map` (or absent) for a generated map, or the name of a map that comes with Rust."
        },
        "levelUrl": {
          "type": [
            "null",
            "string"
          ],
          "description": "The address of a custom map file."
        },
        "seed": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The seed of a generated map, 0 to 2147483647."
        },
        "worldSize": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The world size of a generated map in metres, 1000 to 6000."
        }
      },
      "required": [
        "id"
      ],
      "type": "object",
      "description": "One map of a rotation: a generated map (`seed` and `worldSize`), a map that comes with Rust (`level`) or a custom map (`levelUrl`)."
    },
    "RuleActionWire": {
      "properties": {
        "channels": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Only for `discord.post`: the workspace's Discord channels (`rte_` IDs from the alert manager's channel list) the post goes to; at least one."
        },
        "kind": {
          "type": [
            "null",
            "string"
          ]
        },
        "parameters": {
          "additionalProperties": {
            "$ref": "#/$defs/RuleLiteralWire"
          },
          "type": [
            "null",
            "object"
          ]
        },
        "post": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/DiscordPostWire",
              "description": "Only for `discord.post`: the member's own words, the same post as an alert's (`DiscordPostWire`)."
            }
          ]
        },
        "targets": {
          "items": {
            "$ref": "#/$defs/RuleTargetWire"
          },
          "type": [
            "null",
            "array"
          ]
        }
      },
      "type": "object",
      "description": "One thing a rule does: `server.broadcast` or `notification.send` with the parameter `message`, or `discord.post` with a `post` and\nthe Discord `channels` it goes to."
    },
    "RuleConditionWire": {
      "properties": {
        "field": {
          "type": [
            "null",
            "string"
          ]
        },
        "operator": {
          "type": [
            "null",
            "string"
          ]
        },
        "values": {
          "items": {
            "$ref": "#/$defs/RuleLiteralWire"
          },
          "type": [
            "null",
            "array"
          ]
        }
      },
      "type": "object",
      "description": "A condition on one field of the event; every condition must hold."
    },
    "RuleDefinitionWire": {
      "properties": {
        "actions": {
          "items": {
            "$ref": "#/$defs/RuleActionWire"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "conditions": {
          "items": {
            "$ref": "#/$defs/RuleConditionWire"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "onActionFailure": {
          "type": [
            "null",
            "string"
          ],
          "description": "`stop` or `continue`: whether the actions after a failed one still run."
        },
        "trigger": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/RuleTriggerWire"
            }
          ]
        }
      },
      "type": "object",
      "description": "The definition of a rule, as it is saved and as it is returned."
    },
    "RuleEnabledBody": {
      "properties": {
        "enabled": {
          "type": [
            "null",
            "boolean"
          ]
        }
      },
      "type": "object",
      "description": "Switches a rule on or off."
    },
    "RuleListItemResponse": {
      "properties": {
        "canEnable": {
          "type": "boolean",
          "description": "True when the caller holds `rules.enable` on every server of the rule."
        },
        "canManage": {
          "type": "boolean",
          "description": "True when the caller holds `rules.manage` on every server of the rule."
        },
        "computer": {
          "type": "string",
          "description": "Where the rule runs now: `computer` (the server's own host holds it and keeps running it while RustSC is unreachable), `waiting` (the host\nhas not yet taken the latest change; until it does it keeps running the revision it holds) or `cloud` (RustSC runs it itself, because the server has no\nhost that can hold rules)."
        },
        "latestRun": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/RuleRunSummaryResponse"
            }
          ]
        },
        "rule": {
          "$ref": "#/$defs/RuleResponse"
        }
      },
      "required": [
        "rule",
        "canEnable",
        "canManage",
        "latestRun",
        "computer"
      ],
      "type": "object",
      "description": "A rule in the list, with what the caller may do with it."
    },
    "RuleListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/RuleListItemResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object",
      "description": "The rules the caller can read, newest first."
    },
    "RuleLiteralWire": {
      "properties": {
        "number": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ]
        },
        "text": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object",
      "description": "A literal value in a rule: exactly one of `text` and `number` is set. The rule's own data; nothing in it is ever run or substituted."
    },
    "RuleResponse": {
      "properties": {
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "currentRevision": {
          "format": "int64",
          "type": "integer"
        },
        "definition": {
          "$ref": "#/$defs/RuleDefinitionWire"
        },
        "enabled": {
          "type": "boolean",
          "description": "Whether the rule runs on live events. A saved rule is off until it is switched on."
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "The revision this answer shows; also the ETag."
        },
        "revisionCreatedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "id",
        "revision",
        "currentRevision",
        "name",
        "enabled",
        "definition",
        "createdAt",
        "revisionCreatedAt"
      ],
      "type": "object",
      "description": "One revision of a saved rule."
    },
    "RuleRunActionResponse": {
      "properties": {
        "index": {
          "format": "int32",
          "type": "integer"
        },
        "kind": {
          "type": "string"
        },
        "operationState": {
          "type": [
            "null",
            "string"
          ],
          "description": "The state of the operation the action admitted, now (for example `succeeded`), or null."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ]
        },
        "serverId": {
          "type": "string"
        },
        "state": {
          "type": "string",
          "description": "`pending`, `admitted` (the work was handed to the server's host), `failed` or `skipped`."
        }
      },
      "required": [
        "index",
        "kind",
        "serverId",
        "state",
        "reason",
        "operationState"
      ],
      "type": "object",
      "description": "What one action of a run did on one server."
    },
    "RuleRunResponse": {
      "properties": {
        "actions": {
          "items": {
            "$ref": "#/$defs/RuleRunActionResponse"
          },
          "type": "array"
        },
        "category": {
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "finishedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "id": {
          "type": "string"
        },
        "occurredAt": {
          "format": "date-time",
          "type": "string"
        },
        "origin": {
          "type": "string",
          "description": "`computer` when the server's host decided the run and reported it, `cloud` when RustSC did."
        },
        "outcome": {
          "type": "string"
        },
        "reason": {
          "type": [
            "null",
            "string"
          ]
        },
        "ruleRevision": {
          "format": "int64",
          "type": "integer"
        },
        "serverId": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "ruleRevision",
        "category",
        "serverId",
        "occurredAt",
        "createdAt",
        "finishedAt",
        "outcome",
        "reason",
        "actions",
        "origin"
      ],
      "type": "object",
      "description": "One live event that matched the rule, and what the rule did about it."
    },
    "RuleRunSummaryResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "outcome": {
          "type": "string",
          "description": "`waiting`, `sent`, `failed` or `held_back`."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why it did not happen: `rule_rate_limited`, `workspace_rate_limited`, `server_unavailable`, `definition_unsupported`, `message_unusable` or `stopped_after_failure`."
        }
      },
      "required": [
        "id",
        "at",
        "outcome",
        "reason"
      ],
      "type": "object",
      "description": "How the newest run of a rule ended."
    },
    "RuleRunsPageResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/RuleRunResponse"
          },
          "type": "array"
        },
        "next": {
          "type": [
            "null",
            "string"
          ],
          "description": "Pass as `before` to read the next page; null on the last page."
        }
      },
      "required": [
        "items",
        "next"
      ],
      "type": "object",
      "description": "One page of a rule's runs, newest first."
    },
    "RuleTargetWire": {
      "properties": {
        "kind": {
          "type": [
            "null",
            "string"
          ]
        },
        "serverId": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object",
      "description": "Where an action acts: `event_server` (the server the event happened on) or `server` with its ID."
    },
    "RuleTriggerWire": {
      "properties": {
        "category": {
          "type": [
            "null",
            "string"
          ],
          "description": "For example `server.ready`, `server.saving`, `plugin.unloading` or `chat.message`."
        },
        "schemaVersion": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The category's schema version; 1 for every supported category."
        },
        "serverIds": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The servers the rule listens on, as server IDs. At least one; a server group is not accepted."
        },
        "sourceKinds": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The sources to listen to; left out means all of the category's verified sources."
        }
      },
      "type": "object",
      "description": "What starts a rule: one event category of one schema version on explicit servers."
    },
    "RunModCommandRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "values": {
          "additionalProperties": {
            "type": "string"
          },
          "type": [
            "null",
            "object"
          ]
        }
      },
      "type": "object"
    },
    "RunSavedCommandRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "arguments": {
          "type": [
            "null",
            "object"
          ]
        },
        "keepOutput": {
          "type": [
            "null",
            "boolean"
          ]
        }
      },
      "type": "object",
      "description": "One run of a saved command: one value per declared parameter, of its type (a Steam ID as a decimal string)."
    },
    "RunTimedChangeAgainBody": {
      "properties": {
        "at": {
          "type": [
            "null",
            "string"
          ],
          "description": "The new start, a local date and time such as `2026-11-12T18:00`."
        },
        "endAt": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a change that ends on a date: the new end."
        }
      },
      "type": "object",
      "description": "Run a finished once-only change again on a new date."
    },
    "RustEditMapKeyBody": {
      "properties": {
        "key": {
          "type": "string",
          "description": "The key the map was exported with: 1 to 256 characters, no quote marks."
        }
      },
      "required": [
        "key"
      ],
      "type": "object"
    },
    "RustEditMapKeyResponse": {
      "properties": {
        "isSet": {
          "type": "boolean",
          "description": "A key is stored and has been sent to the server's host; it is used at the next start."
        },
        "updatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the key was last set, or null."
        }
      },
      "required": [
        "isSet"
      ],
      "type": "object",
      "description": "Whether a server has a RustEdit map key. The key is never returned."
    },
    "RustHqApprovalResponse": {
      "properties": {
        "addressChanged": {
          "type": "boolean",
          "description": "True when RustHQ saw a new address for a host it had approved, or gave a new code to one that was waiting: the code is for that new address."
        },
        "code": {
          "type": [
            "null",
            "string"
          ],
          "description": "The code to enter on rusthq.com under API keys; null when RustHQ has not given one yet (press Check again)."
        },
        "since": {
          "format": "date-time",
          "type": "string",
          "description": "When the host started waiting."
        }
      },
      "type": "object",
      "description": "A host RustHQ is waiting on the account's owner to approve."
    },
    "RustHqCheckResponse": {
      "properties": {
        "cloud": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/RustHqHostCheckResponse",
              "description": "For `asked_from_cloud`: RustHQ's answer to RustSC's cloud."
            }
          ]
        },
        "hosts": {
          "items": {
            "$ref": "#/$defs/RustHqHostCheckResponse"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "For `asked`: RustHQ's answer to each host that holds the key."
        },
        "sentTo": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `key_sent`: the name of the host the key was sent to."
        },
        "state": {
          "type": "string",
          "description": "`asked` (hosts were asked, see `hosts`), `key_sent` (the key was just sent to `sentTo`; check again in a moment), `needs_host` (no connected, up-to-date host\ncan ask RustHQ), `asked_from_cloud` (RustSC asked RustHQ itself, see `cloud`), `busy` (too many calls just now) or `no_key`."
        }
      },
      "required": [
        "state"
      ],
      "type": "object",
      "description": "What a Check key came to."
    },
    "RustHqConnectionResponse": {
      "properties": {
        "available": {
          "type": "boolean",
          "description": "False while RustSC has the RustHQ connection switched off; nothing can be saved and the portal shows nothing."
        },
        "check": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/RustHqCheckResponse",
              "description": "What RustHQ said about the key, when this request asked it (a save or Check key); null otherwise."
            }
          ]
        },
        "hosts": {
          "items": {
            "$ref": "#/$defs/RustHqHostResponse"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The workspace's hosts and whether each holds the key; null while no key is saved. RustHQ approves each host, so each is listed."
        },
        "isSet": {
          "type": "boolean",
          "description": "True while a key is saved."
        },
        "updatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the key was last saved; null while none is."
        }
      },
      "required": [
        "available",
        "isSet"
      ],
      "type": "object",
      "description": "The workspace's RustHQ connection. Never the key."
    },
    "RustHqHostCheckResponse": {
      "properties": {
        "code": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `not_approved`: the code the account's owner enters on rusthq.com, under API keys."
        },
        "hostName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The host's name; null for the cloud."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "One lower-case word for a problem result (for example `too_many_waiting`, `site_closed`, `rate_limited`, `no_answer`). Null when the key works. Never the key, a header or a body."
        },
        "result": {
          "type": "string",
          "description": "`works` (RustHQ accepted the key from this host), `wrong_key` (not accepted: wrong or revoked), `not_approved` (the key is real but this host is not approved yet:\nenter `code` on rusthq.com under API keys), `not_allowed` (RustHQ will not let this key work) or `unreachable` (RustHQ did not answer)."
        },
        "rustHqStatus": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The HTTP status of the RustHQ answer that decided a problem result; null when the key works or RustHQ did not answer."
        }
      },
      "required": [
        "result"
      ],
      "type": "object",
      "description": "What RustHQ said to one host (or to the cloud)."
    },
    "RustHqHostResponse": {
      "properties": {
        "approval": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/RustHqApprovalResponse",
              "description": "Set while RustHQ refuses this host until the account's owner approves it on rusthq.com; null when nothing is waiting. The key stays saved meanwhile."
            }
          ]
        },
        "connected": {
          "type": "boolean",
          "description": "Whether the host is connected now."
        },
        "holdsKey": {
          "type": "boolean",
          "description": "Whether the host holds the key (RustSC sends it when a member saves, checks, installs or updates from RustHQ)."
        },
        "name": {
          "type": "string",
          "description": "The name the member knows the host by."
        },
        "ready": {
          "type": "boolean",
          "description": "Whether the host is connected, up to date and holds the key, so it can talk to RustHQ now."
        }
      },
      "required": [
        "name",
        "connected",
        "holdsKey",
        "ready"
      ],
      "type": "object",
      "description": "One of the workspace's hosts as the RustHQ page lists it."
    },
    "RustHqKeyBody": {
      "properties": {
        "key": {
          "type": [
            "null",
            "string"
          ],
          "description": "The account API key from RustHQ's account settings (rusthq.com, Settings, API). It starts with `rhq_`."
        }
      },
      "type": "object",
      "description": "The workspace's own RustHQ key to store. Write-only: it is stored as a protected secret and never returned."
    },
    "SameStartResponse": {
      "properties": {
        "sentence": {
          "type": "string",
          "description": "One plain line for the member (the same words the host's own command prints); empty for `not_needed` and `unavailable`. It never carries a value of the game's start line."
        },
        "state": {
          "type": "string",
          "description": "`same`, `different`, `not_read`, `not_running`, `not_needed` or `unavailable` (the host was not connected, did not answer or could not make the\ncomparison). Treat unknown values as `unavailable`."
        }
      },
      "required": [
        "state",
        "sentence"
      ],
      "type": "object",
      "description": "Whether the next start of a server is the start of the game that runs now, as the host that runs it answered when asked."
    },
    "SaveBanSettingsBody": {
      "properties": {
        "lists": {
          "items": {
            "$ref": "#/$defs/BanListChoiceBody"
          },
          "type": "array"
        },
        "steam": {
          "$ref": "#/$defs/SteamBanSettingsBody"
        }
      },
      "required": [
        "steam",
        "lists"
      ],
      "type": "object",
      "description": "The workspace's ban list choices as the portal saves them (`PUT /ban-settings`). A list the body does not name keeps its choice."
    },
    "SaveFileListingBody": {
      "properties": {
        "folders": {
          "items": {
            "$ref": "#/$defs/FileListingFolderWire"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Every folder, at most 3,000 and 1 MiB of listing in all."
        },
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "`oxide` or `carbon`."
        }
      },
      "type": "object",
      "description": "The listing of every folder the Files area has just read, to be kept for the next opening."
    },
    "SaveHostAlertSettingsBody": {
      "properties": {
        "cpu": {
          "$ref": "#/$defs/AlertRuleSettingBody"
        },
        "diskEnabled": {
          "type": "boolean",
          "description": "The low disk space alert; on until switched off."
        },
        "diskQueue": {
          "$ref": "#/$defs/AlertRuleSettingBody"
        },
        "memory": {
          "$ref": "#/$defs/AlertRuleSettingBody"
        }
      },
      "required": [
        "diskEnabled",
        "cpu",
        "memory",
        "diskQueue"
      ],
      "type": "object"
    },
    "SaveHostOsUpdatesBody": {
      "properties": {
        "aheadOfRestart": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Install ahead of the servers' restart and restart the host at that restart. Offered only where a server on the host has a restart schedule."
        },
        "days": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "ISO weekdays, 1 Monday to 7 Sunday; empty or absent is every day."
        },
        "delayDays": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "after_available only: whole days to wait after the updates first appear, 0 to 30; 3 by default."
        },
        "include": {
          "type": [
            "null",
            "string"
          ],
          "description": "`important` (security and important updates; the standard), `important_and_optional` or `everything` (drivers included)."
        },
        "leadMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Minutes before the restart the install starts, 60 to 240; 120 by default."
        },
        "mode": {
          "type": [
            "null",
            "string"
          ],
          "description": "`off` (the standard), `schedule` (install at a day and time, then restart if needed) or `after_available` (install a number of days after updates appear)."
        },
        "restartWindowHours": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How far after the chosen time a server restart still counts, in hours, 1 to 72; 24 by default."
        },
        "takeOverWindowsRestarts": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Let RustSC stop Windows restarting by itself so it can pick the time; the previous settings are saved and put back when this or the mode is turned off. On by default."
        },
        "time": {
          "type": [
            "null",
            "string"
          ],
          "description": "Local time of day, `HH:mm`; 04:00 by default."
        },
        "timeZone": {
          "type": [
            "null",
            "string"
          ],
          "description": "An IANA time zone name for the day and time; absent or null is the host's own."
        }
      },
      "type": "object",
      "description": "The choice the \"Operating system updates\" form saves for one host. Every field has the form's standard, so a body may leave any out."
    },
    "SaveHostRestartSettingBody": {
      "properties": {
        "restartWithServerRestart": {
          "type": "boolean",
          "description": "True: when the host says it needs a restart, the next scheduled server restart restarts the host. False: it does not."
        }
      },
      "required": [
        "restartWithServerRestart"
      ],
      "type": "object",
      "description": "The choice the host restart panel saves for one host."
    },
    "SaveItemSetRequestBody": {
      "properties": {
        "lines": {
          "items": {
            "$ref": "#/$defs/ItemSetLineBody"
          },
          "type": "array",
          "description": "One to 20 lines, given in this order."
        },
        "name": {
          "type": "string",
          "description": "The name members, 1 to 60 characters, different from the server's other sets."
        }
      },
      "required": [
        "name",
        "lines"
      ],
      "type": "object",
      "description": "Saves a new item set. Saving gives nobody anything."
    },
    "SaveJoinRulesBody": {
      "properties": {
        "allowlist": {
          "$ref": "#/$defs/AllowlistRuleBody"
        },
        "countries": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/CountryRuleBody",
              "description": "The server's own blocked countries. Left out, the rule keeps following the workspace (or keeps the server's own value)."
            }
          ]
        },
        "latency": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/LatencyRuleBody",
              "description": "The latency rule. Left out, the saved one is kept (an older client that does not know it never switches it off)."
            }
          ]
        },
        "steam": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ServerSteamRulesBody",
              "description": "The server's own Steam rules; see ServerSteamRulesBody."
            }
          ]
        }
      },
      "required": [
        "allowlist"
      ],
      "type": "object",
      "description": "The join rules of a server as the portal saves them (`PUT .../join-rules`). The list of allowed players and the latency rule are the server's. Blocked countries, a\npublic Steam profile and the Steam account age follow the workspace unless given here, which makes them the server's own value (use `useWorkspaceJoinRule` to follow\nthe workspace again)."
    },
    "SaveOffsiteBody": {
      "properties": {
        "enabled": {
          "type": [
            "null",
            "boolean"
          ]
        },
        "excludedFolders": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The whole list of folders and files to leave out of the cloud copy, as plain paths with forward slashes below the server's backed-up files (at most 50, each at most 200 characters,\nno pattern characters). Empty clears it; left out keeps it. Nothing is left out unless the member saves it."
        },
        "keepLast": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "3 to 100."
        }
      },
      "type": "object",
      "description": "Changes the switch, the number kept, what is left out or any of them; a field left out stays as it is."
    },
    "SavePermissionSyncBody": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "servers": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The IDs of the servers that take part."
        }
      },
      "required": [
        "enabled",
        "servers"
      ],
      "type": "object",
      "description": "Turns the sync on or off and chooses its servers (`savePermissionSync`). `servers` are the servers that take part; none are ticked for you. Turning it off leaves every server as it is."
    },
    "SavePlayerPermissionTemplateBody": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "1 to 60 characters, unique in the workspace ignoring case."
        },
        "operations": {
          "items": {
            "$ref": "#/$defs/PlayerPermissionOperationBody"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "1 to 100 changes; a staff level is not part of a template."
        }
      },
      "type": "object",
      "description": "Saves a template."
    },
    "SavePluginLibrarySettingsBody": {
      "properties": {
        "autoUpdate": {
          "type": [
            "null",
            "boolean"
          ]
        },
        "hotSwap": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "\"Also swap and reload the plugin on a running set\". Off when left out."
        },
        "keepManual": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The plugin file names kept manual; replaces the list."
        },
        "resume": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The plugin file names to take off a pause (a plugin that kept changing version is paused until a member resumes it)."
        },
        "selfHealing": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "\"Put the previous version back when an update RustSC applied fails to load\"."
        },
        "sourcePicks": {
          "additionalProperties": {
            "type": "string"
          },
          "type": [
            "null",
            "object"
          ],
          "description": "Plugin file name to the file picked from the source's list (a candidate's id). Added to the picks already made; an empty text forgets a pick. 422 `pick` for a file the source did not offer."
        },
        "sources": {
          "additionalProperties": {
            "type": "string"
          },
          "type": [
            "null",
            "object"
          ],
          "description": "Plugin file name to GitHub address (a repository, a releases page or a .cs file). Replaces the update sources when given; a plugin not in it has none. 422 `address` at /sources/{name} for an address that is not recognised."
        },
        "timing": {
          "additionalProperties": {
            "type": "string"
          },
          "type": [
            "null",
            "object"
          ],
          "description": "Plugin file name to `now`, `next_wipe` or `default`: when an update of that plugin is applied. Replaces the plugins' own choices when given; a plugin not in it follows the default."
        },
        "updateTiming": {
          "type": [
            "null",
            "string"
          ],
          "description": "The server's default for when an automatic run applies an update: `next_wipe` (held until the next wipe that counts, then applied) or `now`. Turning the automatic switch on without it chooses `next_wipe`. Left as it is when omitted otherwise."
        }
      },
      "type": "object"
    },
    "SaveRconAccessBody": {
      "properties": {
        "listen": {
          "type": [
            "null",
            "string"
          ],
          "description": "`this_computer` or `all_networks`, for a server RustSC starts, from the next start. Absent keeps the choice."
        },
        "password": {
          "type": [
            "null",
            "string"
          ],
          "description": "The new password. For a server RustSC starts: 8 to 64 characters, each an English letter, a digit, `_`, `.` or `-`, not starting\nwith `-`; it is used from the next start. For a server another tool runs: the password that tool uses (1 to 256 characters without a control\ncharacter), used only to read its console when RustSC finds none in the tool's own files. Absent keeps the password."
        }
      },
      "type": "object",
      "description": "What the Owner saves for a server's RCON: a new password, where the console listens, or both."
    },
    "SaveServerAlertSettingsBody": {
      "properties": {
        "cpu": {
          "$ref": "#/$defs/AlertRuleSettingBody"
        },
        "memory": {
          "$ref": "#/$defs/AlertRuleSettingBody"
        }
      },
      "required": [
        "cpu",
        "memory"
      ],
      "type": "object"
    },
    "SaveServerRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        }
      },
      "type": "object"
    },
    "SaveTemporaryAccessPackBody": {
      "properties": {
        "groups": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The groups the pack gives, such as vip."
        },
        "length": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/TemporaryLengthBody",
              "description": "The usual length, 1 minute to 366 days. Required."
            }
          ]
        },
        "permissions": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Single permissions the pack gives, such as plugin.use."
        }
      },
      "type": "object",
      "description": "Save a pack (`PUT .../temporary-access/packs/{name}`): the groups and permissions and the usual length. The name is the one in the route."
    },
    "SaveWipeExtraToTemplateBody": {
      "type": "object",
      "description": "Save an extra to its plan's template. No members; the body is `{}`."
    },
    "SavedBroadcastListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/SavedBroadcastResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ]
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount"
      ],
      "type": "object"
    },
    "SavedBroadcastRequestBody": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "text": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object",
      "description": "A saved broadcast's definition: a name and the text, sent as server chat and never as a\ncommand. The text is a `game_chat` message template: `{online_players}` and the other\ngame chat variables are filled from the game when it is sent; `{{` and `}}` are\nliteral braces."
    },
    "SavedBroadcastResponse": {
      "properties": {
        "archivedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "serverId": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "syntax": {
          "type": "string",
          "description": "`template` or `text`."
        },
        "text": {
          "type": "string",
          "description": "With `syntax` `template`, the message template as saved; it is rendered and\nneutralized (quotes, backslashes, semicolons and line breaks replaced) when it is sent. With `text` (saved before templates), the neutral text as it is sent."
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "id",
        "serverId",
        "name",
        "revision",
        "state",
        "text",
        "syntax",
        "createdAt",
        "updatedAt",
        "archivedAt"
      ],
      "type": "object"
    },
    "SavedCommandListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/SavedCommandResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ]
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Always null."
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount"
      ],
      "type": "object"
    },
    "SavedCommandRequestBody": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "parameters": {
          "items": {
            "$ref": "#/$defs/CommandParameterBody"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "template": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object",
      "description": "A saved command's definition. `template` is the console line with whole-argument\nplaceholders `{name}`; its first word is the command name. Saving it sends nothing."
    },
    "SavedCommandResponse": {
      "properties": {
        "archivedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "context": {
          "type": "string",
          "description": "`server_console`."
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "parameters": {
          "items": {
            "$ref": "#/$defs/CommandParameterBody"
          },
          "type": "array"
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "The current revision; the `ETag` is `\"r&lt;revision&gt;\"`."
        },
        "serverId": {
          "type": "string"
        },
        "state": {
          "type": "string",
          "description": "`active` or `archived`."
        },
        "template": {
          "type": "string"
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "id",
        "serverId",
        "name",
        "revision",
        "state",
        "context",
        "template",
        "parameters",
        "createdAt",
        "updatedAt",
        "archivedAt"
      ],
      "type": "object"
    },
    "SavedFileListingResponse": {
      "properties": {
        "entryCount": {
          "format": "int32",
          "type": "integer"
        },
        "folderCount": {
          "format": "int32",
          "type": "integer"
        },
        "hash": {
          "type": "string",
          "description": "Revision of this listing, in lower case hex."
        },
        "savedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "hash",
        "savedAt",
        "folderCount",
        "entryCount"
      ],
      "type": "object",
      "description": "What was kept."
    },
    "ScheduleActorResponse": {
      "properties": {
        "id": {
          "type": [
            "null",
            "string"
          ],
          "description": "The account ID for `account`; null otherwise."
        },
        "type": {
          "type": "string",
          "description": "`account`, `support` or `system`. Treat unknown values as other."
        }
      },
      "required": [
        "type",
        "id"
      ],
      "type": "object",
      "description": "Who saved a revision."
    },
    "ScheduleAnnouncementBody": {
      "properties": {
        "channel": {
          "type": [
            "null",
            "string"
          ],
          "description": "The Discord channel to post in (`rte_`); required while a moment is on."
        },
        "moments": {
          "additionalProperties": {
            "$ref": "#/$defs/ScheduleAnnouncementMomentWire"
          },
          "type": "object",
          "description": "The moments by name: `warning` for a schedule, `start` and `end` for a temporary change."
        },
        "roles": {
          "items": {
            "$ref": "#/$defs/ScheduleAnnouncementRoleWire"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Up to 10 Discord roles to mention, by ID; the name is shown on the screen only."
        },
        "special": {
          "type": [
            "null",
            "string"
          ],
          "description": "`everyone` or `here`; left out for neither. Pings only when the bot may mention everyone (Discord's Mention Everyone permission)."
        }
      },
      "required": [
        "moments"
      ],
      "type": "object",
      "description": "The Discord announcement of a schedule (a restart, wipe or game update) or a temporary change. Nothing posts until a\nmoment is switched on and saved. `channel` is one of the workspace's Discord channels (`rte_`); `roles` are the Discord roles the post mentions and\n`special` is `everyone` or `here` only when the member picked it. Nobody else is ever pinged."
    },
    "ScheduleAnnouncementMomentWire": {
      "properties": {
        "on": {
          "type": "boolean",
          "description": "Whether the moment posts. Off keeps the words saved."
        },
        "post": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/DiscordPostWire",
              "description": "The post: a message or card whose text may use the fill-in values `server_name`, `what`, `event_time` (Discord shows it in each reader's own zone;\n`{event_time:relative}` says \"in 5 minutes\") and `remaining_time`. Left out means RustSC's own post. `mention` is ignored: the roles above are the only ping."
            }
          ]
        }
      },
      "required": [
        "on"
      ],
      "type": "object"
    },
    "ScheduleAnnouncementResponse": {
      "properties": {
        "announcement": {
          "$ref": "#/$defs/ScheduleAnnouncementBody"
        },
        "defaults": {
          "additionalProperties": {
            "$ref": "#/$defs/DiscordPostWire"
          },
          "type": "object",
          "description": "RustSC's own post of each moment, for Reset to defaults."
        },
        "saved": {
          "type": "boolean",
          "description": "False when nothing was saved yet: the announcement is RustSC's defaults, every moment off."
        }
      },
      "required": [
        "announcement",
        "saved",
        "defaults"
      ],
      "type": "object"
    },
    "ScheduleAnnouncementRoleWire": {
      "properties": {
        "id": {
          "type": "string",
          "description": "The role's Discord ID (17 to 20 digits)."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The role's name, shown on the screen only."
        }
      },
      "required": [
        "id"
      ],
      "type": "object"
    },
    "ScheduleDailyTimeBody": {
      "properties": {
        "enabled": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Absent means true."
        },
        "localTime": {
          "type": [
            "null",
            "string"
          ],
          "description": "Local time `HH:mm` in the schedule's zone."
        }
      },
      "type": "object",
      "description": "One daily local time."
    },
    "ScheduleDailyTimeResponse": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "localTime": {
          "type": "string",
          "description": "Local time `HH:mm`."
        }
      },
      "required": [
        "localTime",
        "enabled"
      ],
      "type": "object",
      "description": "One daily local time, as saved."
    },
    "ScheduleDefinitionBody": {
      "properties": {
        "arguments": {
          "type": [
            "null",
            "object"
          ],
          "description": "The values of the saved command's parameters, as for a run; none for a broadcast."
        },
        "id": {
          "type": [
            "null",
            "string"
          ],
          "description": "A saved command ID (`cmd_...`) for `server.command`, a saved broadcast ID (`brd_...`) for `server.broadcast`."
        },
        "revision": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The revision you read; another current revision is `412 revision_conflict`."
        }
      },
      "type": "object",
      "description": "The saved definition a recurring command or broadcast runs."
    },
    "ScheduleDefinitionResponse": {
      "properties": {
        "id": {
          "type": "string",
          "description": "The definition ID, `cmd_...` or `brd_...`."
        },
        "resource": {
          "type": "string",
          "description": "`saved_command` or `saved_broadcast`. Treat unknown values as other."
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "The revision whose text every occurrence runs."
        }
      },
      "required": [
        "resource",
        "id",
        "revision"
      ],
      "type": "object",
      "description": "The saved definition revision a schedule runs, as it was approved."
    },
    "ScheduleDeliveryResponse": {
      "properties": {
        "installationId": {
          "type": "string"
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "The revision sent to the host."
        },
        "state": {
          "type": "string",
          "description": "`pending` until the host acknowledged storing it, then `stored`. Treat unknown values as other."
        }
      },
      "required": [
        "revision",
        "installationId",
        "state"
      ],
      "type": "object",
      "description": "Whether the host stored a revision."
    },
    "ScheduleListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/ScheduleResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "The cursor of the next page; null on the last page."
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Always null."
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount"
      ],
      "type": "object",
      "description": "One page of schedules, oldest first."
    },
    "SchedulePreviewRequestBody": {
      "properties": {
        "timeZones": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The IANA zones to work the runs out in, 1 to 20: typically the zone of each chosen server, or the one zone used for all of them."
        },
        "timing": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ScheduleTimingBody",
              "description": "The timing as a schedule would be saved with it; its `timeZone` is ignored (each of `timeZones` is used in turn)."
            }
          ]
        }
      },
      "type": "object",
      "description": "A schedule being written and the time zones to show its next runs in."
    },
    "SchedulePreviewResponse": {
      "properties": {
        "zones": {
          "items": {
            "$ref": "#/$defs/SchedulePreviewZoneResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "zones"
      ],
      "type": "object",
      "description": "The next runs of a schedule being written, per time zone."
    },
    "SchedulePreviewRunResponse": {
      "properties": {
        "dueAt": {
          "format": "date-time",
          "type": "string",
          "description": "When it runs, UTC."
        },
        "local": {
          "type": "string",
          "description": "The same moment on the zone's clock, `YYYY-MM-DDTHH:mm`."
        },
        "note": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why this run is not at the plain clock time, or null: `clock_skipped` (the clocks go forward over the asked time, so it runs right after the jump),\n`clock_repeated` (the asked time happens twice; it runs once, the first time), `clocks_forward` or `clocks_back` (a repeat every few hours\nkeeps its interval, so its clock times move after a change), `day_clamped` (the month has no such day; its last day is used) or\n`moved_to_force_wipe`. Treat unknown values as other."
        }
      },
      "required": [
        "dueAt",
        "local",
        "note"
      ],
      "type": "object",
      "description": "One run."
    },
    "SchedulePreviewZoneResponse": {
      "properties": {
        "runs": {
          "items": {
            "$ref": "#/$defs/SchedulePreviewRunResponse"
          },
          "type": "array",
          "description": "The next 5 runs, soonest first; fewer when the schedule runs fewer times (a single run, or the end of the calendar)."
        },
        "timeZone": {
          "type": "string",
          "description": "The IANA zone."
        }
      },
      "required": [
        "timeZone",
        "runs"
      ],
      "type": "object",
      "description": "The next runs in one time zone."
    },
    "ScheduleRecurrenceBody": {
      "properties": {
        "days": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The days of a `weekdays` schedule, 1 (Monday) to 7 (Sunday), each once, at the anchor's time of day. A host that cannot do it answers\n`409 capability_unavailable` with reason `host_update_needed`."
        },
        "every": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The count for `interval` and `calendar`; for `force_wipe` with unit `minutes`, the minutes after the force wipe moment (0 to 1440)."
        },
        "kind": {
          "type": [
            "null",
            "string"
          ],
          "description": "`interval`, `daily`, `calendar`, `weekdays` (see `days`), `first_thursday`, `once`, or `force_wipe` (existing schedules only; a new one picks the date, see `getForceWipeDates`)."
        },
        "times": {
          "items": {
            "$ref": "#/$defs/ScheduleDailyTimeBody"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The local times of a `daily` schedule, each enabled on its own."
        },
        "unit": {
          "type": [
            "null",
            "string"
          ],
          "description": "`minutes` for `interval`; `days`, `weeks` or `months` for `calendar`; for `force_wipe`, `clock` (the anchor's time of day, no `every`) or `minutes` after the force wipe (with `every`)."
        }
      },
      "type": "object",
      "description": "How a schedule repeats."
    },
    "ScheduleRecurrenceResponse": {
      "properties": {
        "days": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The ISO days (1 Monday to 7 Sunday, ascending) of a `weekdays` schedule; absent for other kinds."
        },
        "every": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "kind": {
          "type": "string"
        },
        "times": {
          "items": {
            "$ref": "#/$defs/ScheduleDailyTimeResponse"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The daily times; null for other kinds."
        },
        "unit": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "kind",
        "every",
        "unit",
        "times"
      ],
      "type": "object",
      "description": "How a schedule repeats, as saved."
    },
    "ScheduleRequestBody": {
      "properties": {
        "channels": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Required for `discord.post`, not allowed otherwise: the workspace's Discord channels (`rte_` IDs) the post goes to, 1 to 10."
        },
        "definition": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ScheduleDefinitionBody",
              "description": "Required for `server.command` and `server.broadcast`, not allowed otherwise: the saved definition each occurrence runs, at the revision you read. A later edit of the definition applies only when you save the schedule again; archiving the definition disables the schedule."
            }
          ]
        },
        "enabled": {
          "type": [
            "null",
            "boolean"
          ]
        },
        "keepOutput": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Required for `server.command`, not allowed otherwise: whether each occurrence keeps the game's reply text (redacted). The reply's size is reported either way."
        },
        "kind": {
          "type": [
            "null",
            "string"
          ],
          "description": "What each occurrence does: `server.restart`, `server.command` (a saved command), `server.broadcast` (a saved broadcast),\n`server.update_game` (updates only when a newer build exists), `server.check_game_update`, `server.backup`,\n`world.reset` (a wipe) or `discord.post` (the cloud posts it in Discord, no host needed). It cannot change after creation."
        },
        "pauseUsualRestarts": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "For `world.reset`: true pauses the server's usual restarts and game updates from the start of the wipe day until the wipe has finished, so an update cannot\nwipe the server early. The pause ends at the latest six hours after the wipe's time. A crash recovery and a person's own restart are never paused. Absent is off on a\nnew schedule and unchanged on a save. Not allowed for other kinds (`not_applicable`)."
        },
        "post": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/DiscordPostWire",
              "description": "Required for `discord.post`, not allowed otherwise: the post's words."
            }
          ]
        },
        "timing": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ScheduleTimingBody"
            }
          ]
        },
        "warningMessage": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `server.restart`, optional: what the countdown says in game chat before each restart, instead of the server's restart message. One line that names\n`{remaining_time}` (for example `Daily restart in {remaining_time:words}.`) and no other variable, up to 200 characters; a message that breaks this is\nrefused with 422 `validation_failed` at `/warningMessage`. Absent or empty uses the server's restart message, so every save must send it again to keep it. Not allowed for other kinds (`not_applicable`)."
        },
        "wipe": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/WipeOptionsBody",
              "description": "For `world.reset`: what each wipe does; absent is the default wipe. Taken now: later changes to the saved wipe settings do not change this schedule. Not allowed for other kinds."
            }
          ]
        }
      },
      "type": "object",
      "description": "One schedule revision as a member saves it: the operation kind, whether it is enabled and the\ncalendar intent. The whole revision is sent on every save; the server is the one in the path."
    },
    "ScheduleResponse": {
      "properties": {
        "channels": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "For a `discord.post` schedule, the Discord channels (`rte_`) it posts in; null for other kinds."
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "definition": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ScheduleDefinitionResponse",
              "description": "The saved definition revision a recurring command or broadcast runs; null for a restart."
            }
          ]
        },
        "disabledReason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Null otherwise. Treat unknown values as other."
        },
        "executor": {
          "type": "string",
          "description": "Who decides and runs occurrences: `host` (the installation's service, also while the cloud\nis unreachable) or `cloud`. Treat unknown values as other."
        },
        "hostDelivery": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ScheduleDeliveryResponse",
              "description": "Whether the host holds the current revision; null for a `cloud` schedule. Until it does,\nan edit or revocation is not in effect on the host, which keeps running the revision it has."
            }
          ]
        },
        "id": {
          "type": "string",
          "description": "Schedule ID, for example `sch_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "keepOutput": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "For a recurring command, whether each occurrence keeps its reply text on the host; null for other kinds."
        },
        "kind": {
          "type": "string",
          "description": "The operation each occurrence admits, for example `server.restart`."
        },
        "nextOccurrence": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/NextOccurrenceResponse",
              "description": "The next occurrence the executor will decide; null when nothing is pending."
            }
          ]
        },
        "pauseUsualRestarts": {
          "type": "boolean",
          "description": "For a `world.reset` schedule, whether the usual restarts are paused on the wipe day until the wipe; false for other kinds."
        },
        "post": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/DiscordPostWire",
              "description": "For a `discord.post` schedule, the member's words as they were saved; null for other kinds."
            }
          ]
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "The current revision; also the ETag (`\"r&lt;revision&gt;\"`)."
        },
        "serverId": {
          "type": "string"
        },
        "state": {
          "type": "string",
          "description": "`active`, `disabled` or `revoked`. Treat unknown values as other."
        },
        "timing": {
          "$ref": "#/$defs/ScheduleTimingResponse"
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        },
        "updatedBy": {
          "$ref": "#/$defs/ScheduleActorResponse",
          "description": "The member who saved the current revision, which approves it."
        },
        "warningMessage": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a `server.restart` schedule, its own countdown wording; null when it says the server's restart message (and for other kinds)."
        },
        "wipe": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/WipeOptionsResponse",
              "description": "For a `world.reset` schedule, what each wipe does as it was saved; null for other kinds."
            }
          ]
        }
      },
      "required": [
        "id",
        "serverId",
        "kind",
        "revision",
        "state",
        "executor",
        "timing",
        "nextOccurrence",
        "hostDelivery",
        "updatedBy",
        "definition",
        "keepOutput",
        "wipe",
        "post",
        "channels",
        "disabledReason",
        "createdAt",
        "updatedAt"
      ],
      "type": "object",
      "description": "A schedule with its current revision, next occurrence and host delivery."
    },
    "ScheduleRunListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/ScheduleRunResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "The cursor of the next page, with the same filters; null on the last page. A page under an outcome filter may hold fewer items and still have one."
        }
      },
      "required": [
        "items",
        "nextCursor"
      ],
      "type": "object",
      "description": "One page of past runs, newest first."
    },
    "ScheduleRunResponse": {
      "properties": {
        "dueAt": {
          "format": "date-time",
          "type": "string",
          "description": "The intended time (UTC)."
        },
        "errorReason": {
          "type": [
            "null",
            "string"
          ],
          "description": "The failed operation's kind-specific reason, when it has one."
        },
        "id": {
          "type": "string",
          "description": "The occurrence, for example `occ_...`."
        },
        "kind": {
          "type": "string",
          "description": "restart, wipe, backup, update, check, message, command, post or hostRestart (the words of the upcoming read); other for a kind this read does not know."
        },
        "operationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The operation it started, if any (open it for the details)."
        },
        "outcome": {
          "type": "string",
          "description": "Treat unknown values as other."
        },
        "place": {
          "type": "string",
          "description": "`server` or `computer`."
        },
        "placeId": {
          "type": "string",
          "description": "The server or host, for example `srv_...` or `host_...`."
        },
        "placeName": {
          "type": [
            "null",
            "string"
          ],
          "description": "Its name; null once it was removed."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a skipped or not-run occurrence its skip reason (as the occurrence list names it); for a failed operation its error code; otherwise null."
        },
        "scheduleId": {
          "type": "string",
          "description": "The schedule it belongs to."
        },
        "scheduleRemoved": {
          "type": "boolean",
          "description": "True when the schedule was removed since; its runs stay."
        },
        "superseded": {
          "type": "boolean",
          "description": "True when the schedule has a later decided run: a failure with a later run is no longer the schedule's latest word."
        },
        "timeZone": {
          "type": "string",
          "description": "The IANA time zone of the schedule revision it ran under."
        }
      },
      "required": [
        "id",
        "scheduleId",
        "scheduleRemoved",
        "kind",
        "place",
        "placeId",
        "placeName",
        "dueAt",
        "timeZone",
        "outcome",
        "reason",
        "errorReason",
        "operationId",
        "superseded"
      ],
      "type": "object",
      "description": "One past run of a schedule: one decided occurrence with its place and plain outcome."
    },
    "ScheduleTimingBody": {
      "properties": {
        "anchor": {
          "type": [
            "null",
            "string"
          ],
          "description": "Local date and time in string? ScheduleTimingBody.TimeZone, `YYYY-MM-DDTHH:mm`, no offset: nothing runs earlier, and its time of day is the time of every kind except `daily`."
        },
        "leadMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Minutes of player warning before each restart, update or wipe. Absent means 0; a command, broadcast, check or backup takes only 0."
        },
        "recurrence": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ScheduleRecurrenceBody"
            }
          ]
        },
        "timeZone": {
          "type": [
            "null",
            "string"
          ],
          "description": "IANA time zone ID, for example `Europe/London`. Every schedule names its zone; none is assumed."
        }
      },
      "type": "object",
      "description": "The calendar intent of a schedule revision."
    },
    "ScheduleTimingResponse": {
      "properties": {
        "anchor": {
          "type": "string",
          "description": "Local date and time, `YYYY-MM-DDTHH:mm:ss`, no offset."
        },
        "leadMinutes": {
          "format": "int32",
          "type": "integer"
        },
        "recurrence": {
          "$ref": "#/$defs/ScheduleRecurrenceResponse"
        },
        "timePolicy": {
          "type": "string",
          "description": "The named rules the revision is calculated under, for example `rsc-1`."
        },
        "timeZone": {
          "type": "string"
        }
      },
      "required": [
        "timeZone",
        "anchor",
        "recurrence",
        "leadMinutes",
        "timePolicy"
      ],
      "type": "object",
      "description": "The calendar intent as saved, with its time policy."
    },
    "SecurityPolicyResponse": {
      "properties": {
        "availableMethods": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The ways of signing in the rule can allow, in the order to show them. Apple is listed only when this deployment has Apple sign-in set up."
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "The revision of the workspace after the last change, for display; the rule is replaced as a whole."
        },
        "sessionDayChoices": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": "array",
          "description": "The session lengths the rule can ask for, in days."
        },
        "sessionDays": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The longest a sign-in lasts for this workspace, in days (1, 7 or 30), or null to keep the account's own session length."
        },
        "signInMethods": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The ways of signing in members may use, or null when every way works."
        }
      },
      "required": [
        "signInMethods",
        "sessionDays",
        "availableMethods",
        "sessionDayChoices",
        "revision"
      ],
      "type": "object",
      "description": "A workspace's own rule about how its members sign in. By default nothing is required."
    },
    "SelectReleaseChannelRequestBody": {
      "properties": {
        "buildFlavor": {
          "type": [
            "null",
            "string"
          ],
          "description": "`none`, or for Carbon `release`, `debug` or `minimal`."
        },
        "channel": {
          "type": [
            "null",
            "string"
          ],
          "description": "The RustSC channel name, for example `public`."
        },
        "platform": {
          "type": [
            "null",
            "string"
          ],
          "description": "`linux-x64` or `windows-x64`."
        }
      },
      "type": "object",
      "description": "Choose a component's release channel. All three values must name one entry of the component's `channels` list."
    },
    "SendSavedBroadcastRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        }
      },
      "type": "object"
    },
    "ServerAccessBody": {
      "properties": {
        "roleId": {
          "type": "string",
          "description": "Role ID. Only a role that can be given on a server is accepted; see `serverScopable` on the role list."
        },
        "serverId": {
          "type": "string",
          "description": "Server ID. A server of another workspace, a removed one and one that never existed are all `not_found`."
        }
      },
      "required": [
        "serverId",
        "roleId"
      ],
      "type": "object",
      "description": "The role a member holds on one server."
    },
    "ServerAlertSettingsResponse": {
      "properties": {
        "cpu": {
          "$ref": "#/$defs/AlertRuleSettingBody"
        },
        "memory": {
          "$ref": "#/$defs/AlertRuleSettingBody"
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "revision",
        "cpu",
        "memory"
      ],
      "type": "object"
    },
    "ServerAlertsResponse": {
      "properties": {
        "alerts": {
          "items": {
            "$ref": "#/$defs/ResourceAlertResponse"
          },
          "type": "array"
        },
        "canManage": {
          "type": "boolean"
        },
        "serverId": {
          "type": "string"
        },
        "serverName": {
          "type": "string"
        },
        "settings": {
          "$ref": "#/$defs/ServerAlertSettingsResponse"
        },
        "supported": {
          "type": "boolean"
        }
      },
      "required": [
        "serverId",
        "serverName",
        "supported",
        "canManage",
        "settings",
        "alerts"
      ],
      "type": "object"
    },
    "ServerBanLiftedResponse": {
      "properties": {
        "globalStillApplies": {
          "type": "boolean",
          "description": "Always true: the global ban keeps the player banned on this server."
        },
        "steamId": {
          "type": "string"
        }
      },
      "required": [
        "steamId",
        "globalStillApplies"
      ],
      "type": "object",
      "description": "A server's own ban was lifted where a global ban also applies (`liftServerBan`)."
    },
    "ServerCommandRouteResponse": {
      "properties": {
        "hostName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The host's name a member reads; absent when there is none."
        },
        "rented": {
          "type": "boolean"
        },
        "state": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a rented server: available, console_needed, not_offered, not_possible_on_host or not_connected. Absent for a server on a host with RustSC installed."
        }
      },
      "required": [
        "rented"
      ],
      "type": "object"
    },
    "ServerConfigurationResponse": {
      "properties": {
        "advanced": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdvancedConfigurationResponse",
              "description": "What the Advanced settings need beyond IReadOnlyList&lt;ConfigurationSettingResponse&gt; ServerConfigurationResponse.Settings: the startup flags RustSC offers and the limits of the\nextra arguments. Saved flags and extra arguments are in IReadOnlyDictionary&lt;string, JsonElement&gt; ServerConfigurationResponse.Values under `rustsc.launch_flags` (a list of\ntext) and `rustsc.extra_arguments` (text). Absent from older servers; treat a missing value as none."
            }
          ]
        },
        "appliedWorld": {
          "additionalProperties": {},
          "type": [
            "null",
            "object"
          ],
          "description": "The map and world values (`server.level`, `server.levelurl`, `server.seed`, `server.worldsize`) that the newest\nsuccessfully applied revision saved, by console variable name; one the revision never saved is absent. Null when no revision was\napplied yet. It may be older than the current revision: compare it with `values` to tell a map saved since."
        },
        "applyState": {
          "type": [
            "null",
            "string"
          ],
          "description": "The apply state of the current revision: `pending` (saved, not applied yet or still\napplying), `applied` (the running game uses every value), `restart_required`\n(written to the server's files; the game uses them from its next start) or `failed`. Null before the first save. Treat unknown values as other."
        },
        "configurationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The configuration's ID (`cfg_...`), or null before the first save."
        },
        "currentApplication": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ConfigurationApplicationResponse",
              "description": "The latest apply of the current revision, or null when it was not applied yet."
            }
          ]
        },
        "imported": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ImportedConfigurationResponse",
              "description": "What RustSC read from the server's own files and launch settings without tying it to a\nsaved revision (an adoption's import), or null when RustSC never read them, as for a server\nRustSC installed: a fresh install has no `server.cfg`, so nothing is imported. A value\nsaved equal to its imported value came from the server."
            }
          ]
        },
        "latestApplication": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ConfigurationApplicationResponse",
              "description": "The latest apply of any revision, or null; it may apply an older revision than the current one."
            }
          ]
        },
        "notices": {
          "items": {
            "$ref": "#/$defs/ListingNoticeResponse"
          },
          "type": "array",
          "description": "What players will notice about the saved listing: a name or description the server list cuts\nshort and tags the game drops or hides. Never an error: every saved value is accepted and\napplied. Empty when nothing stands out. Treat unknown codes as other."
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "The saved revision, also the `ETag` (`\"r&lt;revision&gt;\"`); 0 before the first save."
        },
        "savedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the current revision was saved, or null before the first save."
        },
        "serverId": {
          "type": "string"
        },
        "settings": {
          "items": {
            "$ref": "#/$defs/ConfigurationSettingResponse"
          },
          "type": "array",
          "description": "The settings RustSC manages for this server, in display order, with the rules a save checks:\nthe Rust console variables first, then RustSC's own per-server settings such as\n`rustsc.corrupt_save_mode`, which are saved with the same revision but never written to\n`server.cfg`."
        },
        "values": {
          "additionalProperties": {},
          "type": "object",
          "description": "Every saved value by console variable name, in saved order: text and URLs as strings,\nwhole numbers as numbers, lists as arrays of strings. A setting that is not listed is unset\nand the game uses its own behaviour."
        }
      },
      "required": [
        "serverId",
        "configurationId",
        "revision",
        "savedAt",
        "applyState",
        "values",
        "settings",
        "imported",
        "notices",
        "currentApplication",
        "latestApplication"
      ],
      "type": "object",
      "description": "A server's Rust configuration: the saved values, how far the latest apply got, and the\nsettings RustSC manages with their rules. Saved values are what a member chose; whether the\nrunning game uses them is the apply state and each application's field outcomes."
    },
    "ServerExtrasResponse": {
      "properties": {
        "backupsStatus": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Null when the backups were read (a server with none has no latest backup), otherwise the HTTP status its own route would have answered\n(401, 403 or 404 for a refusal, 500 for another failure). Also null when backups were not asked for."
        },
        "latestBackup": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/BackupResponse",
              "description": "The newest backup; null before the first, when the backups could not be read and when they were not asked for."
            }
          ]
        },
        "measurements": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ListedMeasurementsResponse",
              "description": "The last stored player count and frame rate with when each was seen; null when they cannot be read or were not asked for."
            }
          ]
        },
        "schedules": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ScheduleListResponse",
              "description": "The server's schedules; null when they cannot be read or were not asked for."
            }
          ]
        },
        "serverId": {
          "type": "string"
        },
        "versions": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ServerVersionsResponse",
              "description": "The server's versions; null when they cannot be read or were not asked for."
            }
          ]
        }
      },
      "required": [
        "serverId",
        "measurements",
        "schedules",
        "versions",
        "backupsStatus",
        "latestBackup"
      ],
      "type": "object",
      "description": "The extras of one server in a servers summary. A part is null when it could not be read by the caller."
    },
    "ServerGroupBody": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "What the member calls the group, for example `PvP servers`. Required."
        },
        "serverIds": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Servers to put in the group (`srv_...`)."
        }
      },
      "type": "object",
      "description": "A server group to create: a name and optionally its first servers."
    },
    "ServerGroupListResponse": {
      "properties": {
        "groups": {
          "items": {
            "$ref": "#/$defs/ServerGroupResponse"
          },
          "type": "array"
        },
        "totalCount": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "groups",
        "totalCount"
      ],
      "type": "object",
      "description": "The groups of the workspace by name."
    },
    "ServerGroupMembersBody": {
      "properties": {
        "serverIds": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ]
        }
      },
      "type": "object",
      "description": "Servers to add to or take out of a group."
    },
    "ServerGroupResponse": {
      "properties": {
        "id": {
          "type": "string",
          "description": "The group's ID (`grp_...`)."
        },
        "memberCount": {
          "format": "int32",
          "type": "integer",
          "description": "Servers in the group that the caller can read."
        },
        "name": {
          "type": "string"
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "Raised by every rename and membership change; also the `ETag` (`\"r&lt;revision&gt;\"`)."
        }
      },
      "required": [
        "id",
        "name",
        "revision",
        "memberCount"
      ],
      "type": "object",
      "description": "A group."
    },
    "ServerHostResponse": {
      "properties": {
        "id": {
          "type": "string"
        },
        "kind": {
          "type": "string",
          "description": "`full` or `restricted`. Treat unknown values as other."
        },
        "name": {
          "type": "string"
        },
        "operatingSystem": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "id",
        "name",
        "kind",
        "operatingSystem"
      ],
      "type": "object",
      "description": "The host summary inside a server response."
    },
    "ServerListItemResponse": {
      "properties": {
        "adminState": {
          "type": "string"
        },
        "connection": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/InstallationConnectionResponse",
              "description": "Its installation's connection now, as on the server; null when no enrolled installation routes it."
            }
          ]
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "groupIds": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The server groups containing it that you can see."
        },
        "host": {
          "$ref": "#/$defs/ServerHostResponse"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "runState": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ServerRunStateResponse",
              "description": "Whether the game runs, as the server's host last reported it; null until the host reported\nonce. While the host is not connected this is the last report: compare `observedAt`\nwith the connection."
            }
          ]
        },
        "scheduleTimeZone": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ServerTimeZoneResponse",
              "description": "The time zone the server's schedules use and where it came from."
            }
          ]
        }
      },
      "required": [
        "id",
        "name",
        "adminState",
        "host",
        "groupIds",
        "connection",
        "runState",
        "createdAt"
      ],
      "type": "object",
      "description": "A managed server in a list."
    },
    "ServerListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/ServerListItemResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ]
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount"
      ],
      "type": "object",
      "description": "One page of servers."
    },
    "ServerMapBody": {
      "properties": {
        "level": {
          "type": [
            "null",
            "string"
          ],
          "description": "`Procedural Map` for a generated map, or `CraggyIsland` (the maps the choices list names)\nfor a map the game bundles. Not together with `levelUrl`."
        },
        "levelUrl": {
          "type": [
            "null",
            "string"
          ],
          "description": "The address (`http` or `https`) of a custom map file. The game downloads it and players download it from the game."
        },
        "seed": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "0 to 2147483647 for a generated map; leave it out for a random seed."
        },
        "worldSize": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "Metres, 1000 to 6000, for a generated map."
        }
      },
      "type": "object",
      "description": "A new server's map. Every member is optional; nothing given is the game's default."
    },
    "ServerMeasurementsResponse": {
      "properties": {
        "available": {
          "type": "boolean"
        },
        "fps": {
          "$ref": "#/$defs/CurrentMeasurementResponse"
        },
        "gameCpu": {
          "$ref": "#/$defs/CurrentMeasurementResponse"
        },
        "gameMemory": {
          "$ref": "#/$defs/CurrentMeasurementResponse"
        },
        "players": {
          "$ref": "#/$defs/CurrentMeasurementResponse"
        }
      },
      "required": [
        "available",
        "players",
        "fps",
        "gameCpu",
        "gameMemory"
      ],
      "type": "object"
    },
    "ServerPermissionsResponse": {
      "properties": {
        "permissions": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Permission names held on this server, from the permission catalog."
        },
        "serverId": {
          "type": "string",
          "description": "Server ID, for example `srv_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        }
      },
      "required": [
        "serverId",
        "permissions"
      ],
      "type": "object",
      "description": "The permissions the caller holds on one server."
    },
    "ServerPlayerRecordResponse": {
      "properties": {
        "firstSeenAt": {
          "format": "date-time",
          "type": "string",
          "description": "When RustSC first saw the player."
        },
        "lastSeenAt": {
          "format": "date-time",
          "type": "string",
          "description": "The last time RustSC saw the player."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The newest name; absent when the game never gave one."
        },
        "online": {
          "type": "boolean",
          "description": "True while the player was seen connected a moment ago."
        },
        "sessions": {
          "format": "int32",
          "type": "integer",
          "description": "How many sessions RustSC saw."
        },
        "steamId": {
          "type": "string",
          "description": "The player's Steam ID."
        },
        "totalSeconds": {
          "format": "int64",
          "type": "integer",
          "description": "Whole seconds connected over every session RustSC saw."
        }
      },
      "required": [
        "steamId",
        "firstSeenAt",
        "lastSeenAt",
        "totalSeconds",
        "sessions",
        "online"
      ],
      "type": "object",
      "description": "What RustSC kept about one player of a server it reads while the Players list is open."
    },
    "ServerPlayerRecordsResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/ServerPlayerRecordResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object",
      "description": "A server's player records, newest last seen first."
    },
    "ServerPluginResponse": {
      "properties": {
        "author": {
          "type": [
            "null",
            "string"
          ],
          "description": "The author in the plugin's own header; null when it could not be read."
        },
        "autoUpdate": {
          "$ref": "#/$defs/PluginAutoUpdateResponse",
          "description": "Whether this plugin can update itself with no file from the member (a wipe plan lists only these under Update plugins)."
        },
        "candidates": {
          "items": {
            "$ref": "#/$defs/PluginCandidateResponse"
          },
          "type": "array",
          "description": "Every marketplace in the offered order with what it says about this plugin. A marketplace is never merged with another: its listing and version are its own."
        },
        "custom": {
          "type": "boolean",
          "description": "The member marked the plugin Custom (their own or modified): update.state is unknown with reason custom, autoUpdate.possible is false and keepUpToDate is false."
        },
        "enabled": {
          "type": "boolean",
          "description": "True when the file is in the framework's plugin folder, so the framework loads it; false when RustSC moved it to its disabled folder (disable), where nothing loads it, also after a restart."
        },
        "framework": {
          "type": "string",
          "description": "`oxide` or `carbon`."
        },
        "id": {
          "type": "string",
          "description": "`plg_` identifier, stable while the file stays on the server."
        },
        "keepUpToDate": {
          "type": "boolean",
          "description": "The member's rule \"Keep this plugin up to date\" for this plugin file. False until a member switches it on."
        },
        "kept": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PluginKeptResponse",
              "description": "Set for a library plugin that a saved schedule places for a run and that is not on the server between runs: the schedule and the item. Update changes that item (a new revision of the schedule); the row has no file to switch on, off or remove."
            }
          ]
        },
        "key": {
          "type": "string",
          "description": "The plugin file's path below the framework's plugin folder, for example `HelpText.cs`."
        },
        "listingChoice": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PluginListingChoiceResponse",
              "description": "Set only when two or more marketplaces list a plugin with this file name: which listing leads and why. `state` is `confirmed` (a member chose it), `clear` or\n`not_sure` (the best two are close; `autoUpdate.possible` is false with reason `not_sure` until a member chooses with `choosePluginMarketplace`)."
            }
          ]
        },
        "load": {
          "type": "string",
          "description": "`loaded`, `unloaded` or `failed` only as the game's own plugin list said, and only while the report is current; otherwise `unknown`. The file is always present."
        },
        "loadError": {
          "type": [
            "null",
            "string"
          ],
          "description": "Set only for a plugin of a rented server that the game's own plugin list says failed to load: the one plain line of the first compile error. Absent otherwise."
        },
        "loadReason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Set exactly when `load` is `unknown`: `runtime_not_listed`, `runtime_adapter_unavailable`, `server_not_running`, `game_not_connected`, `host_not_reporting`, `no_report` or another reading code."
        },
        "marketplace": {
          "type": [
            "null",
            "string"
          ],
          "description": "The marketplace the update verdict follows; null when no marketplace has answered that it has this plugin yet."
        },
        "marketplaceSource": {
          "type": [
            "null",
            "string"
          ],
          "description": "`member` when the member chose it, `default` when it is the first marketplace in the offered order that has the plugin."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name in the plugin's own header; null when it could not be read."
        },
        "rustscBuildCurrent": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Set only for the RustSC plugin file (`RustscCompanion.cs`), only while the host's report is current: true when the file on the server is exactly the copy this server's host carries,\nfalse when it differs (the host's copy is newer or the file was changed), absent when the host did not say or the file is not the RustSC plugin. A plugin's version cannot say it, because\nthe RustSC plugin keeps its version across source changes."
        },
        "update": {
          "$ref": "#/$defs/PluginUpdateResponse",
          "description": "The verdict on the selected marketplace only; an update on another marketplace never changes it."
        },
        "usedBy": {
          "items": {
            "$ref": "#/$defs/PluginUsedByResponse"
          },
          "type": "array",
          "description": "The saved schedules that place or switch this plugin (\"Used by Purge\"); empty when none does."
        },
        "version": {
          "type": [
            "null",
            "string"
          ],
          "description": "The installed version, exactly as the plugin's own header writes it; null when it could not be read."
        }
      },
      "required": [
        "id",
        "framework",
        "key",
        "name",
        "author",
        "version",
        "enabled",
        "load",
        "loadReason",
        "marketplace",
        "marketplaceSource",
        "candidates",
        "update",
        "autoUpdate",
        "keepUpToDate",
        "usedBy",
        "custom"
      ],
      "type": "object",
      "description": "One plugin file of a server."
    },
    "ServerPluginsResponse": {
      "properties": {
        "automaticUpdatesPausedUntilForcedWipe": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The force wipe moment (UTC) while updates that run by themselves wait for it: from 24 hours before the monthly forced wipe until the server runs the new game build, or 5 days after the moment at most. Null otherwise. A press of Update is never held."
        },
        "complete": {
          "type": "boolean",
          "description": "False when the host could not list every folder or the server has more plugins than a report lists; plugins missing from an incomplete report are not removed."
        },
        "current": {
          "type": "boolean",
          "description": "True while the newest report is recent. Otherwise every plugin's `load` is `unknown` (`host_not_reporting` or `no_report`) and the list is the last one received."
        },
        "frameworks": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The frameworks installed on the server, `oxide` and `carbon`; empty when neither is."
        },
        "liveReason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why the game's list was not read: `server_not_running`, `game_not_connected`, `runtime_adapter_unavailable` (it is read for Oxide only), `no_framework`, `no_report` or a reading code; null when read."
        },
        "liveState": {
          "type": "string",
          "description": "`read` when the game's own plugin list was read for the newest report, `unavailable` otherwise."
        },
        "marketplaces": {
          "items": {
            "$ref": "#/$defs/PluginMarketplaceResponse"
          },
          "type": "array",
          "description": "Every marketplace in the offered order: uMod, Codefling, Lone.Design, ChaosCode, then any others alphabetically."
        },
        "observedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the host read the plugin folders for the newest report, UTC; null when no report has arrived."
        },
        "plugins": {
          "items": {
            "$ref": "#/$defs/ServerPluginResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "observedAt",
        "current",
        "frameworks",
        "complete",
        "liveState",
        "liveReason",
        "marketplaces",
        "plugins"
      ],
      "type": "object",
      "description": "A server's plugins."
    },
    "ServerPorts": {
      "properties": {
        "game": {
          "format": "int32",
          "type": "integer"
        },
        "query": {
          "format": "int32",
          "type": "integer"
        },
        "rcon": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "game",
        "query",
        "rcon"
      ],
      "type": "object",
      "description": "A new server's network ports: the game (UDP), the server query (UDP) and RCON\n(TCP; WebRCON listens on loopback only). They belong to the launch plan, never to configuration."
    },
    "ServerPortsBody": {
      "properties": {
        "game": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The game port (UDP)."
        },
        "query": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The server query port (UDP), different from the game port."
        },
        "rcon": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The RCON port (TCP), reached only on the host's loopback address."
        }
      },
      "type": "object",
      "description": "A new server's ports. All three are required when the object is given."
    },
    "ServerProtectionPointResponse": {
      "properties": {
        "baseId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The full backup a checkpoint builds on; null for a full backup."
        },
        "bytes": {
          "format": "int64",
          "type": "integer"
        },
        "complete": {
          "type": "boolean",
          "description": "True when every essential file was captured."
        },
        "completedAt": {
          "format": "date-time",
          "type": "string"
        },
        "files": {
          "format": "int64",
          "type": "integer"
        },
        "id": {
          "type": "string"
        },
        "kind": {
          "type": "string",
          "description": "`full` or `checkpoint`."
        },
        "standing": {
          "type": "string",
          "description": "`usable`, `incomplete`, `baseline_missing` or `baseline_unusable`."
        },
        "whileRunning": {
          "type": "boolean",
          "description": "True when the game was running while it was taken."
        },
        "wipe": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "0 for the current world, 1 for the one before the last wipe, and so on; null when unknown."
        }
      },
      "required": [
        "id",
        "kind",
        "baseId",
        "completedAt",
        "files",
        "bytes",
        "complete",
        "whileRunning",
        "standing",
        "wipe"
      ],
      "type": "object",
      "description": "One backup in a server's protection answer."
    },
    "ServerProtectionResponse": {
      "properties": {
        "ageMinutes": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "Whole minutes since the last good backup; null when there is none."
        },
        "bytes": {
          "format": "int64",
          "type": "integer"
        },
        "count": {
          "format": "int64",
          "type": "integer",
          "description": "How many backups the host holds and their size in bytes."
        },
        "lastGoodAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the last good backup finished; null when there is none."
        },
        "limitMinutes": {
          "format": "int32",
          "type": "integer",
          "description": "The age in minutes up to which a backup still counts as recent."
        },
        "points": {
          "items": {
            "$ref": "#/$defs/ServerProtectionPointResponse"
          },
          "type": "array",
          "description": "The newest backups, newest first."
        },
        "reported": {
          "type": "boolean",
          "description": "False until the server's host has reported its backups once; then nothing else is claimed."
        },
        "reportedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the cloud last heard from the host about its backups; null when it has not."
        },
        "state": {
          "type": "string",
          "description": "`protected` (the last good backup is recent enough), `stale` (older), `no_backup` (none is good yet) or `not_reported` (nothing is known yet)."
        }
      },
      "required": [
        "state",
        "reported",
        "lastGoodAt",
        "ageMinutes",
        "limitMinutes",
        "reportedAt",
        "count",
        "bytes",
        "points"
      ],
      "type": "object",
      "description": "How well a server's backups are keeping up."
    },
    "ServerResponse": {
      "properties": {
        "adminState": {
          "type": "string",
          "description": "The administration state: `registering`, `installing`, `adopting`,\n`ready`, `maintenance`, `detached`, `install_failed`,\n`adopt_failed` or `removed`. Treat unknown values as other. Whether the game runs\nis not part of it: see `runState`."
        },
        "connection": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/InstallationConnectionResponse",
              "description": "That installation's connection now; null when there is no such installation. Work for the server is admitted only while it is `connected`, unless held for later."
            }
          ]
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "groupIds": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The groups containing the server that you can see, in ID order."
        },
        "host": {
          "$ref": "#/$defs/ServerHostResponse"
        },
        "id": {
          "type": "string",
          "description": "Server ID, for example `srv_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "installLocation": {
          "type": [
            "null",
            "string"
          ],
          "description": "The folder on the host the server is installed in, chosen when it was added, for example `/srv/rust/example-server`. It does not change after the install."
        },
        "installationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The enrolled installation that routes the server; null for a restricted host or when its installation was revoked, replaced or removed."
        },
        "name": {
          "type": "string",
          "description": "Display name; a label, never an identity."
        },
        "runState": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ServerRunStateResponse",
              "description": "Whether the game runs, as the server's host last reported it; null until the host reported\nonce. While the host is not connected this is the last report: compare `observedAt`\nwith the connection."
            }
          ]
        },
        "scheduleTimeZone": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ServerTimeZoneResponse",
              "description": "The time zone the server's schedules use and where it came from."
            }
          ]
        }
      },
      "required": [
        "id",
        "name",
        "adminState",
        "host",
        "groupIds",
        "installationId",
        "connection",
        "runState",
        "createdAt"
      ],
      "type": "object"
    },
    "ServerRunStateResponse": {
      "properties": {
        "cause": {
          "type": [
            "null",
            "string"
          ],
          "description": "While `failed` with `start_failed`: the most specific cause the host knows, for example\n`save_folder_not_writable` (the game could not write its save folder), `readiness_timeout`\nor `process_ended`; null when unknown. Treat unknown values as other."
        },
        "observedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the host determined it, by the host's clock."
        },
        "phase": {
          "type": [
            "null",
            "string"
          ],
          "description": "While `starting`: what the game is doing as its log shows it, `generating_map` or\n`loading`; null when the host cannot tell. Treat unknown values as other."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why, when the host knows: `exited_unexpectedly` or `start_failed` for\n`failed`, `recovering` for `starting`, `not_confirmed` for `unknown`,\n`rcon_not_answering` for `unresponsive`. Treat unknown values as other."
        },
        "startedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the game process started, by the host's clock (a UTC instant), while the game runs (`starting`, `running` or `unresponsive`) and the host\nservice launched it. Null for a game it did not launch (one found running when the server was added), for a host older than server state revision 6 and\nwhenever the game is not running. A restart gives a new time; the time of a run does not change while the game keeps running."
        },
        "state": {
          "type": "string",
          "description": "`stopped`, `starting`, `running`, `stopping`, `failed`, `unresponsive` (the game process runs but does not answer the host) or `unknown`. Treat unknown values as other."
        },
        "worldCreatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the server's current world was created, as the game reports it (a UTC instant), kept while the game is stopped. Null until the host has read it from the game,\nand for a host older than server state revision 9. The last wipe is the later of this and the last wipe RustSC made."
        }
      },
      "required": [
        "state",
        "reason",
        "phase",
        "cause",
        "observedAt"
      ],
      "type": "object",
      "description": "A server's run state as its host reported it."
    },
    "ServerSoftwareRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the server is busy or its host is offline; leave it out to refuse."
            }
          ]
        }
      },
      "type": "object",
      "description": "An inspection or repair of a server's game files: only the optional admission choices."
    },
    "ServerSteamRulesBody": {
      "properties": {
        "accountAge": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AccountAgeRuleBody"
            }
          ]
        },
        "privateProfile": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/PrivateProfileRuleBody"
            }
          ]
        }
      },
      "type": "object",
      "description": "A server's own value for the Steam rules. A rule left out keeps what it is: following the workspace, or the server's own value. A rule given becomes the server's own\nvalue, switched on or off."
    },
    "ServerSummaryResponse": {
      "properties": {
        "adoption": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResponse",
              "description": "The newest adoption among the server's latest 50 operations, or null."
            }
          ]
        },
        "install": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResponse",
              "description": "The newest install, or null before the first."
            }
          ]
        },
        "lifecycleOperations": {
          "items": {
            "$ref": "#/$defs/OperationResponse"
          },
          "type": "array"
        },
        "recent": {
          "items": {
            "$ref": "#/$defs/OperationResponse"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The newest operations of every kind on this server, newest first (at most 6); null when they cannot be read."
        },
        "removal": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResponse",
              "description": "The newest removal a member asked for, or null."
            }
          ]
        },
        "server": {
          "$ref": "#/$defs/ServerResponse"
        },
        "software": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResponse",
              "description": "The newest inspection or repair, or null before the first."
            }
          ]
        },
        "versions": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ServerVersionsResponse",
              "description": "The server's versions; null when they cannot be read."
            }
          ]
        }
      },
      "required": [
        "server",
        "lifecycleOperations",
        "install",
        "software",
        "removal",
        "versions",
        "recent",
        "adoption"
      ],
      "type": "object",
      "description": "A server with what its page shows first, read together."
    },
    "ServerTimeZoneRequestBody": {
      "properties": {
        "timeZone": {
          "type": [
            "null",
            "string"
          ],
          "description": "An IANA zone id such as `Europe/Berlin`, or null to use the host's zone again."
        }
      },
      "type": "object",
      "description": "The time zone chosen for a server's schedules."
    },
    "ServerTimeZoneResponse": {
      "properties": {
        "chosen": {
          "type": [
            "null",
            "string"
          ],
          "description": "The zone chosen for this server, or null when none was chosen."
        },
        "computer": {
          "type": [
            "null",
            "string"
          ],
          "description": "The zone the server's host reported, or null when it has not said."
        },
        "source": {
          "type": "string",
          "description": "Where it came from: `server` (chosen for this server), `computer` (the host reported it), `workspace` or `none`. Treat unknown values as other."
        },
        "timeZone": {
          "type": [
            "null",
            "string"
          ],
          "description": "The zone new schedules of the server use, an IANA id such as `Europe/Berlin`; null when none of the three is known (the form then shows the browser's zone)."
        },
        "workspace": {
          "type": [
            "null",
            "string"
          ],
          "description": "The zone saved for the workspace, or null."
        }
      },
      "required": [
        "timeZone",
        "source",
        "chosen",
        "computer",
        "workspace"
      ],
      "type": "object",
      "description": "The time zone a server's schedules use: the zone chosen for the server, else the zone its host reported, else the zone saved for the workspace. A new\nschedule stores the zone it was saved with, so a change here moves no saved schedule."
    },
    "ServerVersionsResponse": {
      "properties": {
        "components": {
          "items": {
            "$ref": "#/$defs/ComponentVersionResponse"
          },
          "type": "array",
          "description": "One entry per component: `game`, `oxide` and `carbon`."
        }
      },
      "required": [
        "components"
      ],
      "type": "object",
      "description": "The version evidence of each component of a server."
    },
    "ServersSummaryResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/ServerExtrasResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object",
      "description": "The extras of up to 100 servers."
    },
    "SessionResponse": {
      "properties": {
        "account": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AccountResponse",
              "description": "The signed-in account, or null when signed out."
            }
          ]
        },
        "authenticated": {
          "type": "boolean",
          "description": "True when the request carried a valid session."
        },
        "csrfToken": {
          "type": "string",
          "description": "Send this value in the `X-CSRF-Token` header on every POST, PUT, PATCH and DELETE. Fetch a new one after signing in or out."
        },
        "endsAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When this browser session ends, or null when signed out or when the caller is a native app. The 90 day limit; a client may offer a new sign-in shortly before it."
        },
        "launch": {
          "type": "string"
        },
        "openFeatures": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The features that are available although the launch is `beta` (for example `itemSets` or `blueprints`); empty otherwise. Clients show the controls of a listed feature."
        }
      },
      "required": [
        "authenticated",
        "account",
        "csrfToken"
      ],
      "type": "object",
      "description": "The caller's browser/native account and the request forgery token for unsafe browser requests."
    },
    "SetAssistantRoleBody": {
      "properties": {
        "role": {
          "type": "string",
          "description": "`viewer`, `moderator`, `operator`, `administrator` or `owner`. Never above your own role; lowering is always allowed."
        }
      },
      "required": [
        "role"
      ],
      "type": "object",
      "description": "The new role of an assistant (string AssistantConnectionResponse.Role)."
    },
    "SetAssistantServersBody": {
      "properties": {
        "allServers": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True for every server of the workspace, those added later too. Always sent, so leaving it out never means \"every server\"."
        },
        "serverIds": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The servers when `allServers` is false. Empty is no server. Naming servers together with `allServers` true is refused."
        }
      },
      "type": "object",
      "description": "The servers an assistant (a connected assistant or an agent key) can reach, as a whole."
    },
    "SetBackupPolicyBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "enabled": {
          "type": "boolean"
        },
        "expectedRevision": {
          "format": "int64",
          "type": "integer",
          "description": "The last applied host policy revision, including zero; not an operation or configuration ETag."
        }
      },
      "required": [
        "enabled",
        "expectedRevision"
      ],
      "type": "object"
    },
    "SetBackupRetentionBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "beforeChanges": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Whether a game update, a framework change and a wipe take a backup first unless that one change says otherwise. Absent means true (on)."
        },
        "keep": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The number of backups to keep: `minimum` or more (there is no largest number), or 0 to keep every backup; null goes back to `defaultKeep`."
        },
        "limitGb": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The most the server's backups may use, in GB (1 GB is 1,073,741,824 bytes), from `minimumLimitGb` to `maximumLimitGb`; absent or null means no limit. A change states all of its settings."
        },
        "location": {
          "type": [
            "null",
            "string"
          ],
          "description": "The folder on the server's host where its backups are kept (a full folder path). The host checks it, makes it and proves it writable when this is saved. Absent or null leaves the saved\nlocation as it is; an empty string clears it, and backups stop. Needs a host of version 0.2.47 or later."
        },
        "makeRoom": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Whether the host makes room when the disk is nearly full: it removes old logs, then the oldest backups that are not protected. Absent means false (off)."
        }
      },
      "required": [
        "keep"
      ],
      "type": "object",
      "description": "How many backups to keep, or none for the default."
    },
    "SetChatNameBody": {
      "properties": {
        "chatName": {
          "type": [
            "null",
            "string"
          ],
          "description": "1 to 32 characters. No control characters, no &lt; or &gt; (the game draws chat as rich text), not SERVER, Console, RustSC or System. Leading and trailing spaces are removed. An empty or blank text means messages go out with no name. Null goes back to the default."
        }
      },
      "required": [
        "chatName"
      ],
      "type": "object",
      "description": "The chat name to keep. Always sent: leaving it out must never read as \"go back to the default\"."
    },
    "SetConsoleFilterBody": {
      "properties": {
        "duration": {
          "type": "string",
          "description": "15m, 1h or until_off to switch the filter on for that long; off to switch it off."
        }
      },
      "required": [
        "duration"
      ],
      "type": "object"
    },
    "SetFindRolesBody": {
      "properties": {
        "roles": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ]
        }
      },
      "type": "object",
      "description": "Body of `PUT .../discord-link/find-roles`: the Discord role IDs (at most 20) that may use `/link search` and its Unlink button besides people with\nManage Server. An empty list puts the original rule back (Manage Server only)."
    },
    "SetGameRoleRequestBody": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name to store with the role, optional, up to 64 characters. Quotes, backslashes, semicolons and line breaks are replaced with look-alikes."
        },
        "role": {
          "type": "string",
          "description": "`owner` or `moderator`."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID, 17 digits. The player does not have to be connected."
        }
      },
      "required": [
        "steamId",
        "role"
      ],
      "type": "object",
      "description": "Gives a Steam ID an owner or moderator role in the game. It replaces any other role the Steam ID holds."
    },
    "SetHostUpdateChannelRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the host is busy or offline; leave it out to refuse."
            }
          ]
        },
        "channel": {
          "type": [
            "null",
            "string"
          ],
          "description": "`beta` gets updates early; `production` gets them when they are proven. Nothing is installed by the choice itself."
        }
      },
      "type": "object",
      "description": "Chooses when the host gets updates."
    },
    "SetHostUpdatePolicyRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the host is busy or offline; leave it out to refuse."
            }
          ]
        },
        "mode": {
          "type": [
            "null",
            "string"
          ],
          "description": "`automatic` installs new versions of RustSC on the host by itself; `manual` only when someone presses Update host or runs the update on the host."
        }
      },
      "type": "object",
      "description": "Turns the host's automatic updates on or off."
    },
    "SetInviteLinkBody": {
      "properties": {
        "invite": {
          "type": [
            "null",
            "string"
          ],
          "description": "A Discord invite link (`https://discord.gg/code` or `https://discord.com/invite/code`); null or empty clears it."
        }
      },
      "type": "object"
    },
    "SetLinkWordingBody": {
      "properties": {
        "linkedReply": {
          "type": [
            "null",
            "string"
          ]
        },
        "title": {
          "type": [
            "null",
            "string"
          ]
        },
        "welcome": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object",
      "description": "Body of `PUT .../discord-link/wording`. Each text is saved as sent; empty or null puts RustSC's default back."
    },
    "SetLinkedGroupBody": {
      "properties": {
        "group": {
          "type": "string",
          "description": "The Rust group, by name; it must exist on the server and must not be a staff group."
        }
      },
      "required": [
        "group"
      ],
      "type": "object"
    },
    "SetMarketingPreferenceBody": {
      "properties": {
        "optedIn": {
          "type": "boolean",
          "description": "True to get product updates and news by email, false to stop them. Takes effect at once."
        }
      },
      "required": [
        "optedIn"
      ],
      "type": "object",
      "description": "The choice to keep. Always sent: leaving it out must never read as a change."
    },
    "SetMemberAccessBody": {
      "properties": {
        "hosts": {
          "items": {
            "$ref": "#/$defs/HostAccessBody"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The hosts the member may see, read-only: its status, when it was last seen and its version, and the servers on it they may see. A host\nthe member needs to run a server they were given is listed here too; nothing else about a host is given. Optional: leave it out to keep\nthe member's hosts as they are, send an empty list to take them all away. Not for a member whose workspace role already has everything."
        },
        "servers": {
          "items": {
            "$ref": "#/$defs/ServerAccessBody"
          },
          "type": "array",
          "description": "The member's roles on single servers, at most one role per server; empty for none."
        },
        "workspaceRoleId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The member's role for the whole workspace, or null for none (the member then has only the servers listed). Always sent. Sending the member's present role changes nothing."
        }
      },
      "required": [
        "workspaceRoleId",
        "servers"
      ],
      "type": "object",
      "description": "What a member can do, as it should be after the change. The whole of it is sent: the roles listed here\nare the member's roles on single servers, and roles on servers not listed are taken away."
    },
    "SetNicknameSyncBody": {
      "properties": {
        "enabled": {
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "SetOnlyHereBody": {
      "properties": {
        "keys": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "only": {
          "type": "boolean"
        }
      },
      "required": [
        "keys",
        "only"
      ],
      "type": "object",
      "description": "<b>Only on this server</b> (`only` true) or <b>Sync it</b> (false) for items on one server (`setPermissionSyncOnlyHere`). A key is an item's key, or `g:name` for a whole group."
    },
    "SetPanelExecutorBody": {
      "properties": {
        "on": {
          "type": "boolean",
          "description": "True allows RustSC to change files on this server through its hosting panel; false stops it."
        }
      },
      "required": [
        "on"
      ],
      "type": "object"
    },
    "SetPlayerVitalsRequestBody": {
      "properties": {
        "calories": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Calories (hunger) in whole points, from 0 to the game's maximum (500 today). Left out, it is not changed."
        },
        "health": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Health in whole points, from 1 to the player's maximum (100 normally). Left out, health is not changed."
        },
        "hydration": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Hydration (thirst) in whole points, from 0 to the game's maximum (250 today). Left out, it is not changed."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the player, only so the activity line says it; optional, up to 64 characters."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID of the player, 17 digits. A name never selects a player."
        }
      },
      "required": [
        "steamId"
      ],
      "type": "object",
      "description": "Sets a connected player's health, calories and hydration."
    },
    "SetPluginCustomBody": {
      "properties": {
        "custom": {
          "type": [
            "null",
            "boolean"
          ]
        }
      },
      "type": "object",
      "description": "Mark a plugin file Custom or not."
    },
    "SetPluginKeepUpToDateBody": {
      "properties": {
        "keepUpToDate": {
          "type": [
            "null",
            "boolean"
          ]
        }
      },
      "type": "object",
      "description": "Switch \"Keep this plugin up to date\" for one plugin file."
    },
    "SetPluginPageBody": {
      "properties": {
        "address": {
          "type": [
            "null",
            "string"
          ],
          "description": "The https address of the plugin's page on its marketplace (Codefling, uMod, RustHQ or Lone.Design)."
        }
      },
      "type": "object",
      "description": "The marketplace page of a plugin."
    },
    "SetRecoveryPreferencesBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "enabled": {
          "type": "boolean"
        },
        "expectedRevision": {
          "format": "int64",
          "type": "integer",
          "description": "The observed host setting revision, not an operation ETag or cloud counter."
        },
        "restartIfUnresponsive": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Restart the server by force when it stays unresponsive for unresponsiveMinutes. Left out, the host keeps its setting. Needs servers.lifecycle.force when true."
        },
        "saveRecovery": {
          "type": [
            "null",
            "string"
          ],
          "description": "Save recovery: ask_first or automatic, what the host does when the game finds its save damaged. It takes effect as soon as the host holds it, without a configuration apply. Left out, the host keeps its setting."
        },
        "startAtBoot": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Start the server again after the host restarts. Off until turned on. Left out, the host keeps its setting. Needs servers.lifecycle when true."
        },
        "unresponsiveMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Whole minutes, 5 to 120. Left out, the host keeps its setting."
        }
      },
      "required": [
        "enabled",
        "expectedRevision"
      ],
      "type": "object"
    },
    "SetRentedStartAgainBody": {
      "properties": {
        "on": {
          "type": "boolean",
          "description": "True starts the server again when it stops by itself; false stops that."
        }
      },
      "required": [
        "on"
      ],
      "type": "object"
    },
    "SetSecurityPolicyRequestBody": {
      "properties": {
        "sessionDays": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "1, 7 or 30, or null to keep the account's own session length."
        },
        "signInMethods": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The ways of signing in to allow, at least one, or null for every way."
        }
      },
      "type": "object",
      "description": "Replace the workspace's sign-in rule. Both fields are always sent: null means no limit."
    },
    "SetTemporaryAccessSettingsBody": {
      "properties": {
        "endNotice": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True to tell the player on Discord a day before the end and at the end, if they linked their Discord account. Required."
        }
      },
      "type": "object",
      "description": "Save the temporary access settings (`PUT .../temporary-access/settings`)."
    },
    "SetUpkeepBody": {
      "properties": {
        "discordWhen": {
          "type": [
            "null",
            "string"
          ],
          "description": "When a player who is away is told by Discord: always (the default) or all_offline, only once every player authorised on that cupboard is offline."
        },
        "lowHours": {
          "format": "int32",
          "type": "integer",
          "description": "The first level in hours, 7 to 168."
        },
        "on": {
          "type": "boolean",
          "description": "True saves the setting; false removes it."
        },
        "tellPlayers": {
          "type": "boolean",
          "description": "Whether players are told when a cupboard runs low."
        }
      },
      "required": [
        "on"
      ],
      "type": "object"
    },
    "SettingProfileBody": {
      "properties": {
        "fields": {
          "type": [
            "null",
            "object"
          ],
          "description": "Console variable to value, in the shapes the configuration route uses. Only settings that mean the same on every server are accepted; a refused field is a 422 on `/fields/&lt;name&gt;` with the reason."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "What the member calls the profile, for example `Hardcore rates`. Required."
        }
      },
      "type": "object",
      "description": "A settings profile to save: a name and the fields to copy to servers."
    },
    "SettingProfileListResponse": {
      "properties": {
        "profiles": {
          "items": {
            "$ref": "#/$defs/SettingProfileSummaryResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "profiles"
      ],
      "type": "object",
      "description": "The profiles of the workspace by name."
    },
    "SettingProfileResponse": {
      "properties": {
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "fields": {
          "type": "object"
        },
        "id": {
          "type": "string",
          "description": "The profile's ID (`prf_...`)."
        },
        "name": {
          "type": "string"
        },
        "overrides": {
          "items": {
            "$ref": "#/$defs/ProfileOverrideResponse"
          },
          "type": "array",
          "description": "The servers that keep their own value for some fields. Applying the profile leaves those fields alone."
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "Raised by every save; also the `ETag`."
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "revision",
        "fields",
        "overrides",
        "createdAt",
        "updatedAt"
      ],
      "type": "object",
      "description": "A settings profile."
    },
    "SettingProfileSummaryResponse": {
      "properties": {
        "fieldCount": {
          "format": "int32",
          "type": "integer"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "revision",
        "fieldCount",
        "updatedAt"
      ],
      "type": "object",
      "description": "A profile in the list."
    },
    "SharedEditBody": {
      "properties": {
        "group": {
          "type": [
            "null",
            "string"
          ]
        },
        "kind": {
          "type": "string"
        },
        "permission": {
          "type": [
            "null",
            "string"
          ]
        },
        "present": {
          "type": "boolean"
        },
        "rank": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "steamId": {
          "type": [
            "null",
            "string"
          ]
        },
        "title": {
          "type": [
            "null",
            "string"
          ],
          "description": "The title a group is made with (only when `kind` is `group` and `present` is true)."
        }
      },
      "required": [
        "kind",
        "present"
      ],
      "type": "object",
      "description": "One change made once in the Global view. `kind` is `group`, `member`, `group_permission` or `player_permission`; `present` says whether it should exist."
    },
    "SharedGroupDetailResponse": {
      "properties": {
        "members": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "membersTotal": {
          "format": "int32",
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "paused": {
          "type": "boolean"
        },
        "permissions": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "rank": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "title": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "name",
        "permissions",
        "members",
        "membersTotal",
        "paused"
      ],
      "type": "object",
      "description": "One shared group opened: its permissions and the first members (the rest are only counted)."
    },
    "SharedGroupSummaryResponse": {
      "properties": {
        "members": {
          "format": "int32",
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "paused": {
          "type": "boolean",
          "description": "True when something kept changing this group back and the sync paused it."
        },
        "permissions": {
          "format": "int32",
          "type": "integer"
        },
        "rank": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "title": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "name",
        "permissions",
        "members",
        "paused"
      ],
      "type": "object",
      "description": "One shared group in the Global view: how many permissions and members the sync keeps the same for it."
    },
    "SharedPermissionsResponse": {
      "properties": {
        "group": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/SharedGroupDetailResponse"
            }
          ]
        },
        "groups": {
          "items": {
            "$ref": "#/$defs/SharedGroupSummaryResponse"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "groupsCut": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True when there are more groups than the list shows."
        },
        "playerPermissions": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many of the players' own permissions the sync also keeps the same."
        }
      },
      "type": "object",
      "description": "The shared set in the Global view (`getSharedPermissions`): the groups, or one group opened when `group` was asked for."
    },
    "ShellCountResponse": {
      "properties": {
        "count": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The count, or null when this part was refused or could not be read."
        },
        "status": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The HTTP status the single route would have answered (401, 403 or 404) when this part was refused; null when it answered."
        }
      },
      "required": [
        "count",
        "status"
      ],
      "type": "object",
      "description": "One number of the shell counts: the count, or the status of the refusal when the caller may not read it."
    },
    "ShellCountsResponse": {
      "properties": {
        "alerts": {
          "$ref": "#/$defs/ShellCountResponse",
          "description": "Open alerts among the active ones the caller may see."
        },
        "operations": {
          "$ref": "#/$defs/ShellCountResponse",
          "description": "Operations waiting or in progress that the caller may read."
        },
        "reports": {
          "$ref": "#/$defs/ShellCountResponse",
          "description": "Reports still to work on, over every server the caller may read."
        }
      },
      "required": [
        "operations",
        "alerts",
        "reports"
      ],
      "type": "object",
      "description": "What the left menu and the top bar count, read together."
    },
    "ShuffleMapRequestBody": {
      "properties": {
        "exclude": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "Seeds not to draw again, for example the ones already shown. At most 100 are read."
        },
        "size": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The size in metres, 1000 to 6000."
        }
      },
      "type": "object",
      "description": "Draws a random map the map service already has."
    },
    "SignInAnalyticsRequest": {
      "properties": {
        "campaign": {
          "additionalProperties": {
            "type": "string"
          },
          "type": [
            "null",
            "object"
          ]
        },
        "consentGranted": {
          "type": "boolean"
        },
        "landingPath": {
          "type": [
            "null",
            "string"
          ]
        },
        "optOut": {
          "type": "boolean"
        }
      },
      "type": "object",
      "description": "No visitor identifier or private form field is accepted for measurement."
    },
    "SignInMethodsResponse": {
      "properties": {
        "email": {
          "type": "string",
          "description": "The verified email address. Signing in with an emailed code to it always works and cannot be removed."
        },
        "logins": {
          "items": {
            "$ref": "#/$defs/LoginResponse"
          },
          "type": "array",
          "description": "Linked Google and Discord accounts: at most one of each."
        },
        "maxPasskeyNameLength": {
          "format": "int32",
          "type": "integer",
          "description": "The longest passkey name."
        },
        "maxPasskeys": {
          "format": "int32",
          "type": "integer",
          "description": "The most passkeys one account keeps."
        },
        "passkeyOfferOff": {
          "type": "boolean",
          "description": "True when the person chose \"Don't remind me again\" on the passkey offer after sign-in. The portal shows the offer only while this is false."
        },
        "passkeys": {
          "items": {
            "$ref": "#/$defs/PasskeyResponse"
          },
          "type": "array"
        },
        "providers": {
          "items": {
            "$ref": "#/$defs/SignInProviderResponse"
          },
          "type": "array",
          "description": "The providers this deployment offers, so a missing one can be linked."
        }
      },
      "required": [
        "email",
        "logins",
        "passkeys",
        "providers",
        "maxPasskeys",
        "maxPasskeyNameLength",
        "passkeyOfferOff"
      ],
      "type": "object",
      "description": "How the signed-in person can sign in, and what they can add."
    },
    "SignInOptionsResponse": {
      "properties": {
        "emailCode": {
          "type": "boolean",
          "description": "True when signing in with an emailed code is available."
        },
        "emailSignUp": {
          "type": "boolean",
          "description": "True when an emailed code can also make an account (development and test environments). Otherwise accounts are made with Discord only and the code signs in to an account that exists."
        },
        "passkeys": {
          "type": "boolean",
          "description": "True when passkeys can be used (the service has storage for them)."
        },
        "policies": {
          "$ref": "#/$defs/PolicyVersionsResponse",
          "description": "The Terms and Privacy Policy versions in force. The sign-up page sends them back as `terms` and `privacy` on the provider start address when the person continues; a new account is made only with both."
        },
        "providers": {
          "items": {
            "$ref": "#/$defs/SignInProviderResponse"
          },
          "type": "array",
          "description": "The Google, Discord and Apple sign-in this deployment has set up, in display order. Empty when none is. Only Discord makes an account; Google and Apple sign in to an account that linked them."
        },
        "reviewSignIn": {
          "type": "boolean",
          "description": "True only while an app store review is open and the emailed code is off: the sign-in page then offers the App Review sign-in, which works for the review account alone."
        }
      },
      "required": [
        "providers",
        "passkeys",
        "emailSignUp",
        "emailCode",
        "reviewSignIn",
        "policies"
      ],
      "type": "object",
      "description": "The ways to sign in that this deployment offers, so the sign-in page shows only buttons that work."
    },
    "SignInProviderResponse": {
      "properties": {
        "id": {
          "type": "string",
          "description": "`google` or `discord`. Also the word in `/api/v1/auth/external/{provider}/start`."
        },
        "name": {
          "type": "string",
          "description": "The name to show: Google or Discord."
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object",
      "description": "A provider a person can sign in with."
    },
    "SignInResponse": {
      "properties": {
        "account": {
          "$ref": "#/$defs/AccountResponse",
          "description": "The signed-in account."
        },
        "accountCreated": {
          "type": "boolean",
          "description": "True when this sign-in created the account; the next step is then creating a workspace."
        },
        "providerLinked": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Only for finishing a first Discord sign-in: true when Discord was linked to the account, false when the address already had an account\nthat signed in by the code and nothing was linked (link Discord from Sign-in and security). Absent for every other sign-in."
        }
      },
      "required": [
        "account",
        "accountCreated"
      ],
      "type": "object",
      "description": "The browser is signed in. Fetch the session again for a new request forgery token."
    },
    "SignInRestrictionResponse": {
      "properties": {
        "methods": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The ways of signing in the workspace allows (`passkey`, `apple`, `google`, `discord`); empty means any."
        },
        "reason": {
          "type": "string",
          "description": "`sign_in_method_required` (this session started another way than the workspace allows) or `sign_in_too_old` (the sign-in is older than the workspace allows). Sign in again."
        }
      },
      "required": [
        "reason",
        "methods"
      ],
      "type": "object",
      "description": "Why a session may not use a workspace (the workspace's sign-in rule), and what it allows."
    },
    "SoftwareUpdateResponse": {
      "properties": {
        "channel": {
          "type": "string",
          "description": "The update channel the host follows: `production`, `beta` or `alpha`. Automatic updates are only possible on `production`."
        },
        "channelFellBack": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True when the host was getting updates early, an update failed and it went back to `production` by itself; absent otherwise. It clears when someone chooses a channel again."
        },
        "mode": {
          "type": "string",
          "description": "`automatic` (the host installs new versions by itself), `manual` (only when someone presses Update host or updates on the host) or `package`\n(the host's package manager updates RustSC and its automatic update cannot be read or switched from here, so there is no switch; a package install that can be switched reports `automatic` or `manual` like any other). Treat unknown values as `manual`."
        },
        "observedAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the host reported it, UTC."
        },
        "offeredNotes": {
          "type": [
            "null",
            "string"
          ],
          "description": "Two or three plain sentences the owner approved about the offered version, shown beside it; absent when the release has no notes or nothing is offered."
        },
        "offeredSince": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When RustSC first saw that version offered, UTC; null when nothing is offered."
        },
        "offeredVersion": {
          "type": [
            "null",
            "string"
          ],
          "description": "The newest version the host's own signed channel offers it now; null when none, when its turn in a staged rollout has not come, or when the build needs approval on the host."
        },
        "outdated": {
          "type": "boolean",
          "description": "True when a newer version has been offered to the host for longer than its grace (12 hours 5 minutes when it updates itself, 24 hours when it does not) and it is not updating:\nthe portal says the host is out of date and offers Update host. Never true for a build the host has not been offered."
        },
        "outdatedSince": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the grace ended and the warning began, UTC; null unless `outdated`."
        },
        "setBy": {
          "type": [
            "null",
            "string"
          ],
          "description": "Who chose the mode: `default` (nobody; the starting choice of the platform: automatic on Windows, manual on Linux), `computer` or `portal`;\nnull for `package`. Treat unknown values as `computer`."
        },
        "updating": {
          "type": "boolean",
          "description": "An update of RustSC is running on the host now."
        }
      },
      "required": [
        "mode",
        "setBy",
        "channel",
        "offeredVersion",
        "offeredSince",
        "updating",
        "outdated",
        "outdatedSince",
        "observedAt"
      ],
      "type": "object",
      "description": "How RustSC updates itself on a host, and whether it is out of date."
    },
    "StaffMemberResponse": {
      "properties": {
        "banned": {
          "type": "boolean",
          "description": "True for a player a ban took the role from (the game keeps one entry per Steam ID, so a banned player is not in its staff list) that the member asked to get it back when the ban ends. The role is the one the ban's record remembers. False or left out for a role the game lists now."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name stored with the role; null when none (the game's own `unnamed` is not a name)."
        },
        "operationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The role operation (`op_...`); null with `setBy`."
        },
        "role": {
          "type": "string",
          "description": "`owner` or `moderator`."
        },
        "setAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When that role was requested; null with `setBy`."
        },
        "setBy": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationActorResponse",
              "description": "Who gave this role through RustSC; null for a role given outside RustSC or older than the history RustSC reads."
            }
          ]
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID as a decimal string; keep it a string."
        }
      },
      "required": [
        "steamId",
        "role"
      ],
      "type": "object",
      "description": "One owner or moderator of the game."
    },
    "StaffResponse": {
      "properties": {
        "observedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the host read the file; null without an observation."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why the list is unavailable: `no_observation` or the host's reason, such as `file_unreadable`. Null when observed."
        },
        "staff": {
          "items": {
            "$ref": "#/$defs/StaffMemberResponse"
          },
          "type": "array",
          "description": "Owners first, then moderators, each by name, at most 200. `total` says how many the game holds."
        },
        "state": {
          "type": "string",
          "description": "`observed`, or `unavailable` when the game's file could not be read or no observation arrived in time."
        },
        "total": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "Every owner and moderator the file listed; null when unavailable."
        }
      },
      "required": [
        "state",
        "staff"
      ],
      "type": "object",
      "description": "The game's own owners and moderators: one observation, the same one the live `server.staff` feed\nshows. `state` `unavailable` is never an empty list: `staff` is then empty and `total` null."
    },
    "StageAttachmentBody": {
      "properties": {
        "files": {
          "items": {
            "$ref": "#/$defs/AttachmentFileBody"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "`oxide` or `carbon`."
        },
        "kind": {
          "type": [
            "null",
            "string"
          ],
          "description": "`plugin`, `library`, `config`, `data` or `language`."
        },
        "label": {
          "type": [
            "null",
            "string"
          ],
          "description": "What the person sees (\"Kits profiles\"): up to 120 characters."
        }
      },
      "type": "object",
      "description": "Files to keep until a person has looked at them."
    },
    "StartServerRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "backupFirst": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True backs the stopped server up on its host right before the launch;\na failed backup launches nothing. False or absent starts at once."
        }
      },
      "type": "object",
      "description": "A start, optionally with a backup first."
    },
    "SteamBanSettingsBody": {
      "properties": {
        "enforce": {
          "type": "boolean",
          "description": "True removes a player Steam bans; false only shows the bans on the player."
        },
        "kind": {
          "type": "string",
          "description": "`vac`, `game` or `either`: whose ban count above zero counts."
        },
        "message": {
          "type": "string",
          "description": "What a removed player sees, 1 to 200 characters."
        },
        "withinDays": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "When set, Steam's days since the last ban must also be at most this many (0 to 3650); null for any age."
        }
      },
      "required": [
        "enforce",
        "kind",
        "message"
      ],
      "type": "object",
      "description": "The workspace's Steam ban choice (1 November 2026). Steam is asked about every joining player while the workspace holds its own Steam key and the answer is shown. `enforce` also removes a player Steam refuses, a few seconds after they join; `kind` and `withinDays` only matter then. Steam gives no answer: the player is let in, always."
    },
    "SteamIdentityResponse": {
      "properties": {
        "accountCreatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "communityBanned": {
          "type": [
            "null",
            "boolean"
          ]
        },
        "daysSinceLastBan": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "fetchedAt": {
          "format": "date-time",
          "type": "string"
        },
        "gameBans": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why Steam gave no answer; null when it answered."
        },
        "source": {
          "type": "string",
          "description": "Always `steam_web_api`."
        },
        "vacBans": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "visibility": {
          "type": [
            "null",
            "string"
          ],
          "description": "`public` or `private`."
        }
      },
      "required": [
        "source",
        "fetchedAt"
      ],
      "type": "object",
      "description": "What Steam's Web API said about a player, with when it answered. A fact Steam did not return is null, never zero."
    },
    "SteamKeyBody": {
      "properties": {
        "key": {
          "type": [
            "null",
            "string"
          ],
          "description": "The key from steamcommunity.com/dev/apikey: 32 hexadecimal characters."
        }
      },
      "type": "object",
      "description": "The workspace's own Steam Web API key to store. Write-only: it is stored as a protected secret and never returned. Absent or empty keeps the saved key."
    },
    "SteamKeyResponse": {
      "properties": {
        "holding": {
          "format": "int32",
          "type": "integer",
          "description": "How many of the workspace's hosts hold the key and ask Steam with it."
        },
        "isSet": {
          "type": "boolean",
          "description": "True while a key is saved. When false RustSC's own Steam lookup answers."
        },
        "refused": {
          "format": "int32",
          "type": "integer",
          "description": "How many hosts refused it."
        },
        "updatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the key was last saved; null while none is."
        },
        "waiting": {
          "format": "int32",
          "type": "integer",
          "description": "How many hosts have not received it yet (offline, or not able to hold it)."
        }
      },
      "required": [
        "isSet",
        "holding",
        "waiting",
        "refused"
      ],
      "type": "object",
      "description": "Whether the workspace has its own Steam key and where it stands on the workspace's hosts. Never the key."
    },
    "SteamRulesBody": {
      "properties": {
        "accountAge": {
          "$ref": "#/$defs/AccountAgeRuleBody"
        },
        "privateProfile": {
          "$ref": "#/$defs/PrivateProfileRuleBody"
        }
      },
      "required": [
        "privateProfile",
        "accountAge"
      ],
      "type": "object",
      "description": "The Steam rules of a server."
    },
    "SteamTestResponse": {
      "properties": {
        "hostName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The host that asked Steam, when one did."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `no_host`: `no_key`, or `host_lacks_key`, `host_needs_update` or `host_did_not_answer` from a host that was asked. For `no_answer`: Steam's word\n(`rate_limited`, `timeout`, `steam_error`, or `http_NNN` when Steam answered with that status, for example `http_503`). For `refused`: `http_401`\nor `http_403`, the status Steam answered. Null otherwise."
        },
        "result": {
          "type": "string",
          "description": "`works`, `refused` (Steam did not accept the key), `no_answer` (a host asked and Steam did not answer), `asked` (no host could ask, so RustSC asked Steam with the\nworkspace's own key; the answer is the key's last check a few seconds later) or `no_host` (no key to ask with, so nothing was sent to Steam)."
        }
      },
      "required": [
        "result"
      ],
      "type": "object",
      "description": "How a Send test of the Steam key ended."
    },
    "StopServerRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "backupFirst": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Restart only: true backs the server up on its host after the stop and before the launch; a failed backup leaves it stopped. A stop, or a restart with\n`force`, refuses it with `422` (`backup_first_unsupported`)."
        },
        "force": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True ends the game at once without saving (a forced stop or forced restart, permission\n`servers.lifecycle.force`). False or absent saves, quits and waits for the exit."
        },
        "permissions": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/RestartPermissionsBody",
              "description": "Graceful restart only: player permission changes to write to the framework's files after the stop and before the launch (the changes the running game could not take\nat once, such as a permission no loaded plugin registered). Each change is checked as `applyServerPlayerPermissions` checks it and needs\n`players.permissions.manage` (a staff level also `players.gameroles.manage`). A restart that carries them is a plain restart, never an update. A stop,\na start or a forced restart refuses them with `422` (`/permissions` `permissions_unsupported`). The restart's stage results say what was applied."
            }
          ]
        },
        "warningMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many whole minutes players are warned before the server saves and stops, from 0 to the\nlongest warning (60). 0 acts at once. Absent is the normal warning (5 minutes). A forced\naction takes none and refuses a value above 0 with `422` (`warning_invalid`)."
        }
      },
      "type": "object",
      "description": "A stop or restart, graceful unless bool? StopServerRequestBody.Force is true."
    },
    "StructureKindResponse": {
      "properties": {
        "count": {
          "format": "int32",
          "type": "integer"
        },
        "displayName": {
          "type": "string"
        },
        "prefab": {
          "type": "string"
        }
      },
      "required": [
        "prefab",
        "displayName",
        "count"
      ],
      "type": "object"
    },
    "StructurePreviewResponse": {
      "properties": {
        "buildingId": {
          "type": [
            "null",
            "string"
          ]
        },
        "found": {
          "type": "boolean"
        },
        "generation": {
          "type": "string"
        },
        "kinds": {
          "items": {
            "$ref": "#/$defs/StructureKindResponse"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The entities by kind, most first."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why not: `entity_not_found`, `generation_changed` or `not_a_structure`."
        },
        "revision": {
          "type": [
            "null",
            "string"
          ],
          "description": "What a structure removal must send back; it names exactly this set of entities."
        },
        "stacks": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many item stacks its containers hold, which go with it."
        },
        "total": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many entities the building holds; removing it removes all of them."
        },
        "x": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "z": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        }
      },
      "required": [
        "found",
        "generation"
      ],
      "type": "object"
    },
    "SupportedVariableResponse": {
      "properties": {
        "formats": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The formats accepted after a colon, the default first; empty for a type without formats."
        },
        "name": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "name",
        "type",
        "formats"
      ],
      "type": "object"
    },
    "SwapPluginNowBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "fileName": {
          "type": [
            "null",
            "string"
          ]
        },
        "framework": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object"
    },
    "SwitchRentedFrameworkRequestBody": {
      "properties": {
        "framework": {
          "type": "string",
          "description": "`oxide`, `carbon` or `none` (no framework)."
        }
      },
      "required": [
        "framework"
      ],
      "type": "object",
      "description": "The member's choice on a rented server's Software tab: `oxide`, `carbon` or `none`."
    },
    "SyncPlayerLinksResponse": {
      "properties": {
        "links": {
          "format": "int32",
          "type": "integer",
          "description": "The number of links in the workspace (all servers share them); 0 when nobody has linked yet."
        }
      },
      "required": [
        "links"
      ],
      "type": "object",
      "description": "The answer to Sync now: how many links will be checked against Discord again."
    },
    "TagGroupResponse": {
      "properties": {
        "id": {
          "type": "string",
          "description": "Stable id: `wipe`, `difficulty`, `region`, `style` or `automatic`. Treat unknown ids as other."
        },
        "offered": {
          "type": "boolean",
          "description": "False for tags the game or a framework sets itself: valid, but not for a person to choose."
        },
        "pickOne": {
          "type": "boolean",
          "description": "Whether a server should hold only one tag of the group."
        },
        "tags": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The exact tag names, case-sensitive."
        }
      },
      "required": [
        "id",
        "pickOne",
        "offered",
        "tags"
      ],
      "type": "object",
      "description": "One group of server browser tags."
    },
    "TagVocabularyResponse": {
      "properties": {
        "groups": {
          "items": {
            "$ref": "#/$defs/TagGroupResponse"
          },
          "type": "array"
        },
        "shownLimit": {
          "format": "int32",
          "type": "integer",
          "description": "How many tags the browser shows; the game keeps this many of the known ones."
        }
      },
      "required": [
        "shownLimit",
        "groups"
      ],
      "type": "object",
      "description": "The server browser tags RustSC knows, from Facepunch's documented list."
    },
    "TakeWipeExtraOutBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do while the host is busy or offline: `queue` (wait for the host) when absent, because a take out is never skipped."
            }
          ]
        }
      },
      "type": "object",
      "description": "Take an extra out of the running server now."
    },
    "TeleportPlayerRequestBody": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the player, only so the activity line says it; optional."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID of the player to move, 17 digits. The player may be online, or offline and asleep in the world."
        },
        "toSteamId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The Steam ID of the player to move them to, online or asleep in the world. Exactly one of this and the pair `x` and `z`."
        },
        "x": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "East of the map's centre in whole metres, -4000 to 4000. The game checks the real map: inside its edge, on the ground, not in deep water."
        },
        "z": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "North of the map's centre in whole metres, -4000 to 4000."
        }
      },
      "required": [
        "steamId"
      ],
      "type": "object",
      "description": "Moves one player, online or asleep in the world, to another such player or to a spot."
    },
    "TemplateValueBody": {
      "properties": {
        "stale": {
          "type": [
            "null",
            "boolean"
          ]
        },
        "value": {
          "anyOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/JsonElement"
            }
          ]
        }
      },
      "type": "object",
      "description": "One supplied preview value. `value`: a whole number for counts, durations (seconds),\nbytes and ports; a number for percentages; an ISO 8601 UTC instant for timestamps; a string\nfor text and player names. `stale` true renders it as unknown, as a stale value would."
    },
    "TemporaryAccessEntriesResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/TemporaryAccessEntryResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object",
      "description": "The entries an order reference gave or added time to, after its time was taken off."
    },
    "TemporaryAccessEntryResponse": {
      "properties": {
        "canManage": {
          "type": "boolean",
          "description": "Whether you may add time, end it, keep it or apply it again."
        },
        "endedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When it ended or was kept; null while it runs."
        },
        "endedBy": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationActorResponse",
              "description": "Who ended or kept it; null while it runs."
            }
          ]
        },
        "endsAt": {
          "format": "date-time",
          "type": "string"
        },
        "givenBy": {
          "$ref": "#/$defs/OperationActorResponse",
          "description": "Who gave it."
        },
        "hadBefore": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True when the player already had it before: it stays after the end. Null until it was added."
        },
        "id": {
          "type": "string",
          "description": "The entry (`tac_...`)."
        },
        "kind": {
          "type": "string",
          "description": "group or permission."
        },
        "name": {
          "type": "string",
          "description": "The group or permission."
        },
        "note": {
          "type": [
            "null",
            "string"
          ]
        },
        "playerName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name kept with the entry, or null."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why the last try did not work: group_missing, host_offline, staff_not_allowed, owner_only, not_confirmed, permission_unknown, no_framework, server_removed or failed. Null otherwise."
        },
        "reference": {
          "type": [
            "null",
            "string"
          ],
          "description": "The order reference of the first give; a give that added time with another reference is found by that reference too."
        },
        "serverId": {
          "type": "string",
          "description": "The server (`srv_...`)."
        },
        "serverName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The server's name; null for a removed server."
        },
        "startedAt": {
          "format": "date-time",
          "type": "string"
        },
        "state": {
          "type": "string",
          "description": "adding, active, ending, ended, kept, not_added (could not add) or not_removed (could not take away)."
        },
        "steamId": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "serverId",
        "steamId",
        "kind",
        "name",
        "startedAt",
        "endsAt",
        "state",
        "givenBy",
        "canManage"
      ],
      "type": "object",
      "description": "One group or permission a player has for a set time on one server."
    },
    "TemporaryAccessGivenResponse": {
      "properties": {
        "change": {
          "type": "string",
          "description": "new, added_time, or already_given (the order reference was used before; nothing more was given)."
        },
        "endsAt": {
          "format": "date-time",
          "type": "string",
          "description": "When it ends after this give."
        },
        "id": {
          "type": [
            "null",
            "string"
          ],
          "description": "The entry (`tac_...`); null in a preview of a new entry."
        },
        "kind": {
          "type": "string",
          "description": "group or permission."
        },
        "name": {
          "type": "string"
        },
        "previousEndsAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When it ended before this give, for time added to something the player already has; null otherwise."
        },
        "serverId": {
          "type": "string",
          "description": "The server (`srv_...`)."
        },
        "serverName": {
          "type": [
            "null",
            "string"
          ]
        },
        "state": {
          "type": "string",
          "description": "The entry's state."
        }
      },
      "required": [
        "serverId",
        "kind",
        "name",
        "state",
        "endsAt",
        "change"
      ],
      "type": "object",
      "description": "What a give did, or would do, for one server and one group or permission."
    },
    "TemporaryAccessListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/TemporaryAccessEntryResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "Pass it as cursor for the next page; null on the last page."
        },
        "servers": {
          "items": {
            "$ref": "#/$defs/TemporaryAccessServerResponse"
          },
          "type": "array",
          "description": "The servers you may give temporary access on now."
        }
      },
      "required": [
        "items",
        "servers"
      ],
      "type": "object",
      "description": "One page of temporary access, soonest end first (newest first for ended entries), 100 to a page."
    },
    "TemporaryAccessPackListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/TemporaryAccessPackResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object",
      "description": "The packs of a workspace by name."
    },
    "TemporaryAccessPackResponse": {
      "properties": {
        "groups": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "length": {
          "$ref": "#/$defs/TemporaryLengthResponse",
          "description": "The usual length, used when a give names the pack and no other length."
        },
        "name": {
          "type": "string",
          "description": "The pack's name, at most 40 characters. Names are compared without regard to case."
        },
        "permissions": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "name",
        "groups",
        "permissions",
        "length",
        "updatedAt"
      ],
      "type": "object",
      "description": "A saved pack: a name, the groups and permissions it gives and its usual length (\"VIP 30 days\")."
    },
    "TemporaryAccessServerResponse": {
      "properties": {
        "id": {
          "type": "string",
          "description": "The server (`srv_...`)."
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object",
      "description": "A server you may give temporary access on now."
    },
    "TemporaryAccessSettingsResponse": {
      "properties": {
        "endNotice": {
          "type": "boolean",
          "description": "True when the player is told on Discord a day before the end and at the end, if they linked their Discord account. Off until saved on."
        }
      },
      "required": [
        "endNotice"
      ],
      "type": "object",
      "description": "The temporary access settings of a workspace."
    },
    "TemporaryAccessTimeBody": {
      "properties": {
        "endsAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "A later end. Give this or length."
        },
        "length": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/TemporaryLengthBody",
              "description": "How long to add to the time left. Give this or endsAt."
            }
          ]
        }
      },
      "type": "object",
      "description": "Add time to an entry (`POST .../temporary-access/{id}/actions/add-time`)."
    },
    "TemporaryLengthBody": {
      "properties": {
        "amount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How many, 1 or more."
        },
        "unit": {
          "type": [
            "null",
            "string"
          ],
          "description": "minutes, hours or days."
        }
      },
      "type": "object",
      "description": "A length of time: an amount of minutes, hours or days."
    },
    "TemporaryLengthResponse": {
      "properties": {
        "amount": {
          "format": "int32",
          "type": "integer"
        },
        "unit": {
          "type": "string",
          "description": "minutes, hours or days."
        }
      },
      "required": [
        "amount",
        "unit"
      ],
      "type": "object",
      "description": "A length as an amount and a unit."
    },
    "TimedChangeActionBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the server is busy or its host is offline; leave it out to refuse."
            }
          ]
        }
      },
      "type": "object",
      "description": "Start now or End now. The body may be empty (`{}`)."
    },
    "TimedChangeActiveListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/TimedChangeActiveResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object"
    },
    "TimedChangeActiveResponse": {
      "properties": {
        "changeId": {
          "type": "string"
        },
        "heldPaths": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The paths of the files this run holds in place now (a file it puts in place or takes away), for the mark in the Files area."
        },
        "name": {
          "type": "string"
        },
        "run": {
          "$ref": "#/$defs/TimedChangeRunResponse"
        }
      },
      "required": [
        "changeId",
        "name",
        "run",
        "heldPaths"
      ],
      "type": "object"
    },
    "TimedChangeCopyResponse": {
      "properties": {
        "changeId": {
          "type": "string"
        },
        "operation": {
          "$ref": "#/$defs/OperationResponse"
        },
        "targetServerId": {
          "type": "string"
        },
        "transferId": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a target on another host: the transfer to follow with a receive once the send has finished; null for a copy inside one host."
        }
      },
      "required": [
        "operation",
        "changeId",
        "targetServerId",
        "transferId"
      ],
      "type": "object",
      "description": "A copy to another server: the operation that starts it, the new paused change and, for another host, the transfer the files travel through."
    },
    "TimedChangeDefinitionResponse": {
      "properties": {
        "end": {
          "$ref": "#/$defs/TimedChangeEndResponse"
        },
        "files": {
          "type": [
            "null",
            "string"
          ],
          "description": "`folder` when the change's files are the ones in its visible folder on the host; absent when it names its files in `items`."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/TimedChangeItemResponse"
          },
          "type": "array"
        },
        "messages": {
          "$ref": "#/$defs/TimedChangeMessagesResponse"
        },
        "name": {
          "type": "string"
        },
        "start": {
          "$ref": "#/$defs/TimedChangeStartResponse"
        },
        "timeZone": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "name",
        "timeZone",
        "items",
        "start",
        "end",
        "messages"
      ],
      "type": "object",
      "description": "A definition as it was saved, or as a starting point offers it (members the member chooses are empty)."
    },
    "TimedChangeEffectResponse": {
      "properties": {
        "op": {
          "type": "string"
        },
        "subject": {
          "type": "string"
        },
        "text": {
          "type": "string"
        }
      },
      "required": [
        "op",
        "subject",
        "text"
      ],
      "type": "object"
    },
    "TimedChangeEndBody": {
      "properties": {
        "at": {
          "type": [
            "null",
            "string"
          ]
        },
        "hoursAfter": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "For `after_force_wipe`: whole hours after the force wipe moment."
        },
        "kind": {
          "type": [
            "null",
            "string"
          ]
        },
        "minutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "scheduleId": {
          "type": [
            "null",
            "string"
          ]
        },
        "time": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object",
      "description": "When a temporary change ends: `manual`; `after` (`minutes` from the real start); `at_time` (the next `time` after the start); `on_date`\n(`at`, for a change that starts once); `at_wipe` (the server's next wipe, scheduled or pressed); or `with_restart` (the next run of the restart\nschedule `scheduleId` after the start); `at_force_wipe` (the next force wipe moment); `after_force_wipe` (`hoursAfter` hours after the force wipe\nmoment); or `at_next_wipe` (the next wipe of the server, scheduled, pressed or the force wipe, whichever comes first)."
    },
    "TimedChangeEndResponse": {
      "properties": {
        "at": {
          "type": [
            "null",
            "string"
          ]
        },
        "hoursAfter": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "kind": {
          "type": "string"
        },
        "minutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "scheduleId": {
          "type": [
            "null",
            "string"
          ]
        },
        "time": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "kind",
        "minutes",
        "time",
        "at",
        "scheduleId",
        "hoursAfter"
      ],
      "type": "object"
    },
    "TimedChangeFileListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/TimedChangeFileResponse"
          },
          "type": "array"
        },
        "maxServerBytes": {
          "format": "int64",
          "type": "integer",
          "description": "Bytes of saved files the server may keep."
        },
        "message": {
          "type": "string",
          "description": "\"2 saved files, 3.4 MB of the 2.1 GB this server may keep. They are kept on your server's host until you delete the temporary change that uses them.\""
        },
        "sourceBytes": {
          "format": "int64",
          "type": "integer",
          "description": "Bytes of the files listed, each counted once."
        }
      },
      "required": [
        "items",
        "sourceBytes",
        "maxServerBytes",
        "message"
      ],
      "type": "object"
    },
    "TimedChangeFileResponse": {
      "properties": {
        "held": {
          "type": "boolean",
          "description": "True when every change that uses it has been confirmed by the host with nothing missing."
        },
        "name": {
          "type": "string",
          "description": "The name the member knows it by: the dropped file's name, or the file the change puts it at."
        },
        "origin": {
          "type": "string",
          "description": "`upload` or `library`."
        },
        "sha256": {
          "type": "string",
          "description": "Use this value and the file's size to select it in a temporary change."
        },
        "size": {
          "format": "int64",
          "type": "integer"
        },
        "state": {
          "type": "string",
          "description": "\"On your server's host\" or \"Waiting for your server's host\"."
        },
        "usedBy": {
          "items": {
            "$ref": "#/$defs/TimedChangeFileUseResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "sha256",
        "size",
        "name",
        "origin",
        "held",
        "state",
        "usedBy"
      ],
      "type": "object",
      "description": "A file available for temporary changes."
    },
    "TimedChangeFileUseResponse": {
      "properties": {
        "changeId": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "changeId",
        "name"
      ],
      "type": "object",
      "description": "A change that uses a saved file."
    },
    "TimedChangeFolderFileResponse": {
      "properties": {
        "modified": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the file last changed, where the host's platform reports it."
        },
        "path": {
          "type": "string",
          "description": "The path below the change's folder, `/` separated (`place/plugins/Kits.cs`)."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `not_used` and `blocked`: a stable code saying why; null otherwise."
        },
        "size": {
          "format": "int64",
          "type": "integer"
        },
        "state": {
          "type": "string",
          "description": "`will_be_used`, `in_use`, `changed`, `new`, `removed`, `not_used` or `blocked`."
        }
      },
      "required": [
        "path",
        "size",
        "modified",
        "state",
        "reason"
      ],
      "type": "object",
      "description": "One file in a change's visible folder as its host last reported it."
    },
    "TimedChangeFolderListsBody": {
      "properties": {
        "remove": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "turnOff": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "turnOn": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ]
        }
      },
      "type": "object",
      "description": "The three text lists of a schedule's folder; a list left out is left as it is."
    },
    "TimedChangeFolderListsResponse": {
      "properties": {
        "remove": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "turnOff": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "turnOn": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "remove",
        "turnOff",
        "turnOn"
      ],
      "type": "object",
      "description": "The lines of the three text lists as the host read them."
    },
    "TimedChangeFolderResponse": {
      "properties": {
        "changeId": {
          "type": "string"
        },
        "fileCount": {
          "format": "int32",
          "type": "integer",
          "description": "How many files the folder holds; the list below shows at most 300."
        },
        "files": {
          "items": {
            "$ref": "#/$defs/TimedChangeFolderFileResponse"
          },
          "type": "array"
        },
        "folder": {
          "type": [
            "null",
            "string"
          ],
          "description": "The folder's path below the game folder; null when the host found none."
        },
        "lists": {
          "$ref": "#/$defs/TimedChangeFolderListsResponse"
        },
        "notReadyMessage": {
          "type": [
            "null",
            "string"
          ],
          "description": "What the member reads for `notReadyReason`; null when there is none."
        },
        "notReadyReason": {
          "type": [
            "null",
            "string"
          ]
        },
        "reported": {
          "type": "boolean"
        },
        "runStartedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "runState": {
          "type": [
            "null",
            "string"
          ],
          "description": "The state of the change's open run (`on`, `ending`, `stuck`), or null when none is open."
        },
        "scannedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the host looked, so the page can show how old the list is."
        },
        "usedBytes": {
          "format": "int64",
          "type": "integer"
        },
        "usedCount": {
          "format": "int32",
          "type": "integer"
        },
        "usesFolder": {
          "type": "boolean"
        }
      },
      "required": [
        "changeId",
        "usesFolder",
        "reported",
        "folder",
        "notReadyReason",
        "notReadyMessage",
        "scannedAt",
        "runState",
        "runStartedAt",
        "fileCount",
        "usedCount",
        "usedBytes",
        "files",
        "lists"
      ],
      "type": "object",
      "description": "What the host last reported about the visible folder of a temporary change: names, sizes, times and states, never contents. `reported` is false until the host has\nsent a look (everything else is then empty); `usesFolder` is false for a change that keeps saved copies of its files."
    },
    "TimedChangeFolderWorkBody": {
      "properties": {
        "action": {
          "type": [
            "null",
            "string"
          ],
          "description": "`create`, `lists` or `export`."
        },
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the server is busy or its host is offline; leave it out to refuse."
            }
          ]
        },
        "lists": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/TimedChangeFolderListsBody",
              "description": "For `lists`: the lines to write."
            }
          ]
        }
      },
      "type": "object",
      "description": "Work on a schedule's visible folder on its host: `create` the folder, replace its `lists`, or `export` the saved copies into it (Use a folder)."
    },
    "TimedChangeItemBody": {
      "properties": {
        "destination": {
          "type": [
            "null",
            "string"
          ]
        },
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `move`: `oxide` or `carbon`."
        },
        "op": {
          "type": [
            "null",
            "string"
          ]
        },
        "plugin": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `move`: the plugin's name, its file name without `.cs`."
        },
        "source": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/TimedChangeSourceBody"
            }
          ]
        },
        "to": {
          "type": [
            "null",
            "string"
          ],
          "description": "For `move`: `disabled` or `enabled`."
        }
      },
      "type": "object",
      "description": "One file change. `place` puts `source` over `destination` (a path below `oxide` or `carbon`, in plugins, config or configs, data or\nlang); `remove` takes `destination` away; `move` turns a plugin of `framework` off (`to` `disabled`) or on (`enabled`). The\noriginal of a file is held by the server's host and put back exactly when the change ends."
    },
    "TimedChangeItemResponse": {
      "properties": {
        "destination": {
          "type": [
            "null",
            "string"
          ]
        },
        "framework": {
          "type": [
            "null",
            "string"
          ]
        },
        "op": {
          "type": "string"
        },
        "plugin": {
          "type": [
            "null",
            "string"
          ]
        },
        "source": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/TimedChangeSourceResponse"
            }
          ]
        },
        "to": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "op",
        "destination",
        "source",
        "framework",
        "plugin",
        "to"
      ],
      "type": "object"
    },
    "TimedChangeListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/TimedChangeResponse"
          },
          "type": "array"
        },
        "maxPerServer": {
          "format": "int32",
          "type": "integer"
        },
        "maxServerBytes": {
          "format": "int64",
          "type": "integer",
          "description": "Bytes of saved files the server may keep."
        },
        "sourceBytes": {
          "format": "int64",
          "type": "integer",
          "description": "Bytes of saved files the server keeps now."
        },
        "storageMessage": {
          "type": "string",
          "description": "\"Temporary changes use 14 MB of what this server may keep.\""
        }
      },
      "required": [
        "items",
        "sourceBytes",
        "maxServerBytes",
        "maxPerServer",
        "storageMessage"
      ],
      "type": "object"
    },
    "TimedChangeMessagesBody": {
      "properties": {
        "end": {
          "type": [
            "null",
            "string"
          ],
          "description": "Sent once after the files are back."
        },
        "start": {
          "type": [
            "null",
            "string"
          ],
          "description": "Sent once after the files are in place."
        }
      },
      "type": "object",
      "description": "The optional lines for the players. Empty means no message: RustSC never makes one up."
    },
    "TimedChangeMessagesResponse": {
      "properties": {
        "end": {
          "type": "string"
        },
        "start": {
          "type": "string"
        }
      },
      "required": [
        "start",
        "end"
      ],
      "type": "object"
    },
    "TimedChangeNextTimeResponse": {
      "properties": {
        "basedOn": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The wipe or restart the start is counted from."
        },
        "endAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "startAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "startAt",
        "basedOn",
        "endAt"
      ],
      "type": "object"
    },
    "TimedChangeNextTimesResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/TimedChangeNextTimeResponse"
          },
          "type": "array"
        },
        "message": {
          "type": [
            "null",
            "string"
          ]
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why there are none: `paused`, `manual`, `no_wipe_scheduled`, `no_restart_scheduled` or `no_later_start`."
        }
      },
      "required": [
        "items",
        "reason",
        "message"
      ],
      "type": "object"
    },
    "TimedChangeOverlapResponse": {
      "properties": {
        "changeId": {
          "type": "string"
        },
        "kind": {
          "type": "string",
          "description": "`file` or `plugin`."
        },
        "message": {
          "type": "string",
          "description": "A sentence for the member. Saving is never blocked by an overlap."
        },
        "name": {
          "type": "string"
        },
        "subject": {
          "type": "string"
        }
      },
      "required": [
        "changeId",
        "name",
        "kind",
        "subject",
        "message"
      ],
      "type": "object"
    },
    "TimedChangePreviewBody": {
      "properties": {
        "changeId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The change being edited, as the API returned its ID. Left out for a new one."
        },
        "end": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/TimedChangeEndBody"
            }
          ]
        },
        "files": {
          "type": [
            "null",
            "string"
          ],
          "description": "`folder` or left out, as on a save."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/TimedChangeItemBody"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "messages": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/TimedChangeMessagesBody"
            }
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "start": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/TimedChangeStartBody"
            }
          ]
        },
        "timeZone": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object",
      "description": "A temporary change as a member is writing it, to check before saving. The same members as a save, and `changeId` to name the change being edited, whose own\nfiles and name are not a conflict."
    },
    "TimedChangePreviewResponse": {
      "properties": {
        "effects": {
          "items": {
            "$ref": "#/$defs/TimedChangeEffectResponse"
          },
          "type": "array"
        },
        "fileCount": {
          "format": "int32",
          "type": "integer"
        },
        "maxServerBytes": {
          "format": "int64",
          "type": "integer"
        },
        "nextTimes": {
          "items": {
            "$ref": "#/$defs/TimedChangeNextTimeResponse"
          },
          "type": "array"
        },
        "noStartMessage": {
          "type": [
            "null",
            "string"
          ]
        },
        "noStartReason": {
          "type": [
            "null",
            "string"
          ]
        },
        "overlaps": {
          "items": {
            "$ref": "#/$defs/TimedChangeOverlapResponse"
          },
          "type": "array"
        },
        "serverSourceBytes": {
          "format": "int64",
          "type": "integer",
          "description": "What the server would keep after saving."
        },
        "sourceBytes": {
          "format": "int64",
          "type": "integer"
        },
        "summary": {
          "type": "string",
          "description": "The sentence that names the heavy effects, or empty."
        }
      },
      "required": [
        "effects",
        "summary",
        "nextTimes",
        "noStartReason",
        "noStartMessage",
        "overlaps",
        "fileCount",
        "sourceBytes",
        "serverSourceBytes",
        "maxServerBytes"
      ],
      "type": "object"
    },
    "TimedChangeRequestBody": {
      "properties": {
        "enabled": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "On a save: false keeps the change paused. Left out, a new change is on and a changed one stays as it is."
        },
        "end": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/TimedChangeEndBody"
            }
          ]
        },
        "files": {
          "type": [
            "null",
            "string"
          ],
          "description": "`folder` for a change whose files are the ones in its visible folder on the server's host at every start (it then has no items); left out for a change that names\nits files in `items`. Refused with `capability_unavailable` (`host_needs_update`) for a host that does not read folders."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/TimedChangeItemBody"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "messages": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/TimedChangeMessagesBody"
            }
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "start": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/TimedChangeStartBody"
            }
          ]
        },
        "timeZone": {
          "type": [
            "null",
            "string"
          ],
          "description": "The member's IANA time zone, for example `Europe/London`. Start and end times are local to it."
        }
      },
      "type": "object",
      "description": "A temporary change as a member writes it. Saving starts nothing."
    },
    "TimedChangeResponse": {
      "properties": {
        "active": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/TimedChangeRunResponse"
            }
          ]
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "definition": {
          "$ref": "#/$defs/TimedChangeDefinitionResponse"
        },
        "delivery": {
          "type": "string",
          "description": "`waiting` until the server's host has confirmed the newest revision, then `confirmed`; `no_computer` when the server has none."
        },
        "deliveryMessage": {
          "type": [
            "null",
            "string"
          ]
        },
        "enabled": {
          "type": "boolean",
          "description": "False while the change is paused."
        },
        "fileCount": {
          "format": "int32",
          "type": "integer",
          "description": "Items in the change: files put in place or taken away and plugins turned on or off."
        },
        "filesMessage": {
          "type": "string",
          "description": "\"3 files, 2.1 MB. Kept until you delete this temporary change.\""
        },
        "group": {
          "type": "string",
          "description": "`active`, `upcoming` (which holds paused and not ready) or `finished`."
        },
        "id": {
          "type": "string"
        },
        "lastRun": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/TimedChangeRunResponse"
            }
          ]
        },
        "name": {
          "type": "string"
        },
        "nextStart": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "noStartMessage": {
          "type": [
            "null",
            "string"
          ]
        },
        "noStartReason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why there is no next start: `manual`, `no_wipe_scheduled`, `no_restart_scheduled` or `no_later_start`. Null when there is one or the change is paused."
        },
        "notReadyMessage": {
          "type": [
            "null",
            "string"
          ],
          "description": "What the member reads for `notReadyReason`: a file it needs is missing, or the saved version waits for its files to reach the host. Null when the change is ready."
        },
        "notReadyPlugins": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The plugins behind `notReadyReason`: for `plugin_missing` the names of the plugins the host cannot find (names only, at most 200), for `plugin_duplicate` one\nentry for each plugin stored in two places with its two paths joined by `|`. Empty when there are none, when the change is ready and for a host that does not send them."
        },
        "notReadyReason": {
          "type": [
            "null",
            "string"
          ]
        },
        "overlaps": {
          "items": {
            "$ref": "#/$defs/TimedChangeOverlapResponse"
          },
          "type": "array"
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "The current revision; the `ETag` is `\"r&lt;revision&gt;\"`."
        },
        "serverId": {
          "type": "string"
        },
        "sourceBytes": {
          "format": "int64",
          "type": "integer"
        },
        "sourceFileCount": {
          "format": "int32",
          "type": "integer",
          "description": "Files the server keeps for the change, each counted once however many items use it."
        },
        "state": {
          "type": "string",
          "description": "`on`, `upcoming`, `paused`, `not_ready` or `finished`."
        },
        "stateLabel": {
          "type": "string"
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "id",
        "serverId",
        "name",
        "revision",
        "enabled",
        "state",
        "group",
        "stateLabel",
        "definition",
        "fileCount",
        "sourceFileCount",
        "sourceBytes",
        "nextStart",
        "noStartReason",
        "noStartMessage",
        "lastRun",
        "active",
        "delivery",
        "deliveryMessage",
        "notReadyReason",
        "notReadyMessage",
        "notReadyPlugins",
        "overlaps",
        "filesMessage",
        "createdAt",
        "updatedAt"
      ],
      "type": "object"
    },
    "TimedChangeRunListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/TimedChangeRunResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object"
    },
    "TimedChangeRunResponse": {
      "properties": {
        "canKeepOn": {
          "type": "boolean",
          "description": "True when this run was undone only because the game never said whether a plugin loaded. The change can then be kept on anyway (`POST .../actions/keep-on`) while it has no run that is on. False for every other run."
        },
        "dueAt": {
          "format": "date-time",
          "type": "string"
        },
        "endedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "endsAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "id": {
          "type": "string"
        },
        "message": {
          "type": "string",
          "description": "The history line of the run in plain words: what started it, how it ended and what that did to the files (\"Ended with the wipe. 4 files put back.\")."
        },
        "notes": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Plain sentences about what the host did that the history line (string TimedChangeRunResponse.Message) does not say: \"Your edited copy of TruePVE.json was kept as\nTruePVE.json.kept-20261105-190000.\", an original that could not be found, a plugin that did not load again. Empty when there is nothing to add."
        },
        "outcome": {
          "type": [
            "null",
            "string"
          ],
          "description": "How it ended: `on_time`, `ended_early`, `extended`, `failsafe`, `late`, `undone` or `skipped`. Null while it is on."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "A skip reason (`missed`, `not_ready`, `already_on` and the others) or a failure code. Null otherwise."
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "startedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "state": {
          "type": "string",
          "description": "`on`, `ending`, `stuck`, `ended`, `undone` or `skipped`."
        }
      },
      "required": [
        "id",
        "revision",
        "state",
        "outcome",
        "reason",
        "dueAt",
        "startedAt",
        "endsAt",
        "endedAt",
        "message",
        "notes",
        "canKeepOn"
      ],
      "type": "object",
      "description": "A run of a temporary change, or a start that was skipped."
    },
    "TimedChangeSourceBody": {
      "properties": {
        "displayName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The file name the member sees."
        },
        "libraryName": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a library plugin: its name in the library."
        },
        "libraryVersion": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a library plugin: the version pinned when it was saved."
        },
        "origin": {
          "type": [
            "null",
            "string"
          ],
          "description": "`upload` (a file the member added) or `library` (a plugin from the library, pinned to the version shown when it was saved)."
        },
        "sha256": {
          "type": [
            "null",
            "string"
          ],
          "description": "The fingerprint of the file, 64 lowercase hexadecimal digits."
        },
        "size": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The size in bytes."
        }
      },
      "type": "object",
      "description": "Identifies an uploaded file or library plugin to use in a temporary change."
    },
    "TimedChangeSourceResponse": {
      "properties": {
        "displayName": {
          "type": [
            "null",
            "string"
          ]
        },
        "libraryName": {
          "type": [
            "null",
            "string"
          ]
        },
        "libraryVersion": {
          "type": [
            "null",
            "string"
          ]
        },
        "origin": {
          "type": "string"
        },
        "sha256": {
          "type": "string"
        },
        "size": {
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "sha256",
        "size",
        "origin",
        "displayName",
        "libraryName",
        "libraryVersion"
      ],
      "type": "object"
    },
    "TimedChangeStartBody": {
      "properties": {
        "at": {
          "type": [
            "null",
            "string"
          ]
        },
        "days": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "daysBefore": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "hoursBefore": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "For `before_force_wipe`: whole hours before the force wipe moment."
        },
        "kind": {
          "type": [
            "null",
            "string"
          ]
        },
        "scheduleId": {
          "type": [
            "null",
            "string"
          ]
        },
        "time": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object",
      "description": "When a temporary change starts: `manual`; `once` (`at`, a local date and time such as `2026-11-05T18:00`); `daily` (`time`, such as\n`18:00`); `weekly` (`days`, `mon` to `sun`, and `time`); `before_wipe` (`scheduleId` of the server's wipe schedule,\n`daysBefore` and `time`); `with_restart` (`scheduleId` of the server's restart schedule and, optionally, `days`);\n`before_force_wipe_day` (`daysBefore` calendar days before the day of the force wipe in the member's zone, at `time`; it names no schedule); or\n`before_force_wipe` (`hoursBefore` hours before the force wipe moment)."
    },
    "TimedChangeStartResponse": {
      "properties": {
        "at": {
          "type": [
            "null",
            "string"
          ]
        },
        "days": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "daysBefore": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "hoursBefore": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "kind": {
          "type": "string"
        },
        "scheduleId": {
          "type": [
            "null",
            "string"
          ]
        },
        "time": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "kind",
        "at",
        "time",
        "days",
        "daysBefore",
        "scheduleId",
        "hoursBefore"
      ],
      "type": "object"
    },
    "TimedChangeStartingPointListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/TimedChangeStartingPointResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object"
    },
    "TimedChangeStartingPointResponse": {
      "properties": {
        "example": {
          "$ref": "#/$defs/TimedChangeDefinitionResponse",
          "description": "An example to edit. It is not saved and schedules nothing."
        },
        "hint": {
          "type": "string"
        },
        "key": {
          "type": "string",
          "description": "`pvp_purge_before_wipe` or `daily_plugin_rotation`."
        },
        "title": {
          "type": "string"
        }
      },
      "required": [
        "key",
        "title",
        "hint",
        "example"
      ],
      "type": "object"
    },
    "UnbanPlayerRequestBody": {
      "properties": {
        "steamId": {
          "type": "string",
          "description": "The Steam ID to unban, 17 digits. It does not have to be in the list shown."
        }
      },
      "required": [
        "steamId"
      ],
      "type": "object",
      "description": "Removes a ban."
    },
    "UnlockCrateRequestBody": {
      "properties": {
        "afterSeconds": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Seconds until it unlocks by itself, 0 to 3600; absent or 0 unlocks it now."
        },
        "generation": {
          "type": "string",
          "description": "The world generation the crate was seen in."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows, only so the activity line says it; optional, up to 64 characters."
        },
        "netId": {
          "type": "string",
          "description": "The network ID of the crate, as text."
        }
      },
      "required": [
        "netId",
        "generation"
      ],
      "type": "object",
      "description": "Unlocks one hackable crate now or after a time."
    },
    "UnlockPlayerBlueprintsRequestBody": {
      "properties": {
        "item": {
          "type": [
            "null",
            "string"
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the portal shows for the player, only so the activity line says it; optional, up to 64 characters."
        },
        "steamId": {
          "type": "string",
          "description": "The Steam ID of the player, 17 digits. A name never selects a player."
        }
      },
      "required": [
        "steamId"
      ],
      "type": "object",
      "description": "Unlocks one blueprint or all of them for a connected player."
    },
    "UnsubscribeResponse": {
      "properties": {
        "state": {
          "type": "string",
          "description": "`unsubscribed` when the account was opted in and now is not, `already_unsubscribed` when it was off already (the link was used before). Either way no product update email is sent to the account."
        }
      },
      "required": [
        "state"
      ],
      "type": "object",
      "description": "The answer to an unsubscribe link that worked."
    },
    "UpcomingChangeItemsResponse": {
      "properties": {
        "files": {
          "format": "int32",
          "type": "integer"
        },
        "plugins": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "files",
        "plugins"
      ],
      "type": "object",
      "description": "What a temporary change swaps: files put in place or taken away, and plugins turned on or off."
    },
    "UpcomingChangeWhenResponse": {
      "properties": {
        "end": {
          "$ref": "#/$defs/TimedChangeEndResponse"
        },
        "start": {
          "$ref": "#/$defs/TimedChangeStartResponse"
        },
        "timeZone": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "start",
        "end",
        "timeZone"
      ],
      "type": "object",
      "description": "When a temporary change starts and ends, as saved, and the time zone its times are in."
    },
    "UpcomingQuietResponse": {
      "properties": {
        "categories": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "endsAt": {
          "format": "date-time",
          "type": "string"
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "running": {
          "type": "boolean"
        },
        "scope": {
          "type": "string"
        },
        "startsAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "scope",
        "categories",
        "startsAt",
        "endsAt",
        "running",
        "revision"
      ],
      "type": "object",
      "description": "A quiet time for alerts: when alerts of some kinds are not sent."
    },
    "UpcomingScheduleListResponse": {
      "properties": {
        "incomplete": {
          "type": "boolean",
          "description": "True when a source could not be read, so the list may be missing rows. A source the caller may not read is not a failure."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/UpcomingScheduleRowResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items",
        "incomplete"
      ],
      "type": "object",
      "description": "Everything that happens by the clock for the servers and hosts the caller may, in one read: server schedules, temporary changes, host restart schedules, a Windows\nhost's update choice and quiet times for alerts, soonest first. The wording is the client's, in the member's language; the rows carry facts and codes."
    },
    "UpcomingScheduleRowResponse": {
      "properties": {
        "anchor": {
          "type": [
            "null",
            "string"
          ],
          "description": "The local time of the first run (`yyyy-MM-ddTHH:mm:ss`), which a calendar repeat counts from."
        },
        "changeItems": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/UpcomingChangeItemsResponse",
              "description": "For a temporary change, how many files it puts in place or takes away and how many plugins it turns on or off; null for other kinds."
            }
          ]
        },
        "changeWhen": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/UpcomingChangeWhenResponse",
              "description": "For a temporary change, when it starts and ends as it was saved (the same members as the change's own definition) and its time zone; null for other kinds."
            }
          ]
        },
        "endsAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The end of the current or next scheduled window, when known; null for schedules without an end time."
        },
        "id": {
          "type": "string",
          "description": "Unique in the list: the schedule, temporary change, saved wipe (wipe plan) or quiet time ID, or `os_updates/{computer ID}`. Not shown to people."
        },
        "installsUpdates": {
          "type": "boolean",
          "description": "A Restart host schedule that installs Windows updates before its restart; the host then has no separate updates row."
        },
        "kind": {
          "type": "string",
          "description": "`restart`, `wipe`, `backup`, `update`, `check`, `message`, `command`, `post` (a Post to Discord step), `change` (a temporary change), `computerRestart`,\n`computerUpdates`, `quietTime` or `other`. Treat unknown values as other."
        },
        "leadMinutes": {
          "format": "int32",
          "type": "integer",
          "description": "Minutes of warning before it runs; 0 for none."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "A temporary change's or a saved wipe's name (typed by a member: untrusted text); null for other kinds."
        },
        "nextAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "The next time (UTC); null when it has none, is paused or is on now."
        },
        "onUntil": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "A temporary change or quiet time that is on now ends at this time (UTC)."
        },
        "onlyIfNeeded": {
          "type": "boolean",
          "description": "A host restart that happens only while the host needs one."
        },
        "paused": {
          "type": "boolean",
          "description": "True when a member switched it off."
        },
        "place": {
          "type": "string",
          "description": "`server`, `computer` or `workspace` (a quiet time for everything)."
        },
        "placeId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The server or host (`srv_...`, `host_...`); null for the whole workspace."
        },
        "placeName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The server's or host's name; null for the whole workspace and for a place the caller may not read."
        },
        "quiet": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/UpcomingQuietResponse",
              "description": "A quiet time's facts; null for every other kind."
            }
          ]
        },
        "readsFolder": {
          "type": "boolean",
          "description": "A temporary change whose files are the ones in its visible folder on the host (it has a Files view). False for every other row; left out by an older cloud, which reads as false."
        },
        "recurrence": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ScheduleRecurrenceResponse",
              "description": "How it repeats, for a server schedule or a host restart; null for the other kinds."
            }
          ]
        },
        "skipsServerRestarts": {
          "type": "boolean",
          "description": "A host restart after which its servers skip their own restart that day."
        },
        "startsWithRestart": {
          "type": "boolean",
          "description": "A temporary change, not on now, whose start is \"with the restart\" of a named restart schedule. Its `nextAt` is then the time of that restart\n(on the chosen days, if it names days). False for every other row. Left out by an older cloud, which reads as false."
        },
        "stoppedReason": {
          "type": [
            "null",
            "string"
          ],
          "description": "A temporary change with no next start says why: `waiting_for_you` (it starts only when the member presses Start), `not_ready` (the host lacks a file it needs) or `waiting_for_schedule` (it follows a wipe or restart that is not planned). Treat unknown values as stopped."
        },
        "text": {
          "type": [
            "null",
            "string"
          ],
          "description": "What a message or command schedule sends, as captured when it was saved (typed by a member: untrusted text): the message's text, the command as it is\nsent. Null for other kinds, and for a command when the caller may not read the server's saved commands (servers.console.read)."
        },
        "timeZone": {
          "type": [
            "null",
            "string"
          ],
          "description": "The time zone the repeat is stated in."
        },
        "updates": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/UpcomingUpdatesResponse",
              "description": "A Windows host's update choice; null for every other kind."
            }
          ]
        },
        "warningMessage": {
          "type": [
            "null",
            "string"
          ],
          "description": "A server restart schedule's own countdown wording (typed by a member: untrusted text); null when it says the server's restart message, and for other kinds."
        },
        "wipeSettings": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a wipe schedule, the name of the saved wipe it runs (typed by a member: untrusted text); null when it runs none, and for other kinds."
        }
      },
      "required": [
        "id",
        "kind",
        "place",
        "placeId",
        "placeName",
        "nextAt",
        "paused",
        "stoppedReason",
        "onUntil",
        "recurrence",
        "anchor",
        "timeZone",
        "leadMinutes",
        "name",
        "onlyIfNeeded",
        "skipsServerRestarts",
        "updates",
        "quiet"
      ],
      "type": "object",
      "description": "One row: what happens, where, and when next."
    },
    "UpcomingUpdatesResponse": {
      "properties": {
        "aheadOfRestart": {
          "type": "boolean",
          "description": "True when the install happens with the next scheduled server restart."
        },
        "days": {
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": "array",
          "description": "Weekdays, 0 is Sunday; empty or all seven means every day."
        },
        "delayDays": {
          "format": "int32",
          "type": "integer"
        },
        "mode": {
          "type": "string",
          "description": "`schedule` (on chosen days at a time) or `after_available` (some days after an update appears)."
        },
        "time": {
          "type": "string",
          "description": "Local time `HH:mm`."
        }
      },
      "required": [
        "mode",
        "delayDays",
        "days",
        "time",
        "aheadOfRestart"
      ],
      "type": "object",
      "description": "When a Windows host installs its updates."
    },
    "UpdateGameRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "backup": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True takes an ordinary backup after the server stops, before anything changes; false takes none. Absent follows the server's\n\"Back up before changes\" setting (on until it is switched off). The backup is listed and rotated with the others."
        },
        "extensions": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True also updates RustEdit and the RustSC plugin in the same restart when they are behind, false leaves them; absent follows the server's saved automatic update ticks. Needs the game."
        },
        "framework": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "False leaves Oxide or Carbon alone (only the game is updated). Absent is true."
        },
        "game": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "False leaves the game alone (only Oxide or Carbon is updated). Absent is true."
        },
        "warningMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Minutes of player warning before the server stops, from 0 to the longest warning (60); players\nsee a countdown in chat. Absent means the normal warning of 5 minutes; 0 stops at once."
        }
      },
      "type": "object",
      "description": "Update game: the player warning and the optional admission choices."
    },
    "UpdateHostRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the host is busy or offline; leave it out to refuse."
            }
          ]
        },
        "version": {
          "type": [
            "null",
            "string"
          ],
          "description": "The version the member confirmed, from the check's `availableVersion`, for example `0.2.7`. The host refuses with `not_offered` when its channel offers another."
        },
        "whileBusy": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True when the member confirmed that the update may interrupt other work running on the host; absent means false."
        }
      },
      "type": "object",
      "description": "Updates the host to the version the member confirmed."
    },
    "UpdateKeptPluginBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody",
              "description": "What to do when the server is busy or its host is offline; leave it out to refuse."
            }
          ]
        },
        "destination": {
          "type": [
            "null",
            "string"
          ],
          "description": "The destination of the item that places the plugin, as the change names it, for example `carbon/plugins/Caravan.cs`."
        }
      },
      "type": "object",
      "description": "Update a library plugin that a saved temporary change places."
    },
    "UpdatePluginLibraryFromFolderBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "fileNames": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The plugin file names to take from the plugins folder."
        },
        "framework": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object"
    },
    "UpdatePluginLibraryFromSourceBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "fileNames": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The plugin file names to take from their update sources."
        },
        "framework": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object"
    },
    "UpdatePreferencesBody": {
      "properties": {
        "items": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The things RustSC keeps up to date at server restarts, ticked one by one: `rustedit` and `rustsc_plugin` (a future one is one more id). Absent keeps what is saved; an empty list unticks all. Nothing is ticked until a member saves it. Anything else is 422 on `/items`."
        },
        "onDetection": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Restart when an update is found: a check that finds a newer build starts Update game with the normal player warning."
        },
        "onRestart": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Update on restart: a restart applies a pending game update in the same stop and start."
        },
        "waitMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "How long after an update appears RustSC waits before restarting for it, in whole minutes: 60, 120, 180, 360, or 0 for no wait. It applies only to `onDetection`; a restart under\n`onRestart` and pressing Update game update at once. Absent keeps what is saved; anything else is 422 on `/waitMinutes`."
        }
      },
      "type": "object",
      "description": "Both automatic update settings of a server; each is required."
    },
    "UpdatePreferencesResponse": {
      "properties": {
        "delivery": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResponse",
              "description": "The operation that gives the saved settings to the host, as it is now; null when never saved."
            }
          ]
        },
        "items": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The items ticked for \"Update automatically at server restarts\" (`rustedit`, `rustsc_plugin`). Empty until a member ticks one. A graceful restart updates these, after the game\nstops and before it starts, when a newer file exists; it never installs an item that is not there and never fails or waits on an update."
        },
        "onDetection": {
          "type": "boolean",
          "description": "Restart when an update is found. Off until a member turns it on."
        },
        "onRestart": {
          "type": "boolean",
          "description": "Update on restart. Off until a member turns it on."
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "Raised by every save that changes something; 0 means never saved."
        },
        "updatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the settings were last saved, UTC; null when never saved."
        },
        "waitMinutes": {
          "format": "int32",
          "type": "integer",
          "description": "The wait before `onDetection` restarts for an update, in whole minutes counted from when RustSC first saw the update (the 15 minute read can add up to 15 minutes): 60, 120, 180, 360,\nor 0 for no wait. It never delays `onRestart`. 0 until a member chooses one; a server never saved shows 0 and the form pre-fills 120."
        }
      },
      "required": [
        "onRestart",
        "onDetection",
        "items",
        "waitMinutes",
        "revision",
        "updatedAt",
        "delivery"
      ],
      "type": "object",
      "description": "A server's automatic update settings."
    },
    "UpkeepCupboardResponse": {
      "properties": {
        "grid": {
          "type": [
            "null",
            "string"
          ],
          "description": "The map square as players read it (a letter and a number); absent when the plugin could not tell."
        },
        "id": {
          "type": "string"
        },
        "minutes": {
          "format": "int32",
          "type": "integer"
        },
        "snoozed": {
          "type": "boolean"
        },
        "state": {
          "type": "string",
          "description": "ok, low, last_hours or ran_out."
        },
        "x": {
          "format": "int32",
          "type": "integer"
        },
        "z": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "id",
        "x",
        "z",
        "minutes",
        "state",
        "snoozed"
      ],
      "type": "object"
    },
    "UpkeepLinkResponse": {
      "properties": {
        "state": {
          "type": "string",
          "description": "stopped: the player's alerts for the server are off. snoozed: the cupboard is snoozed."
        }
      },
      "required": [
        "state"
      ],
      "type": "object"
    },
    "UpkeepSettingResponse": {
      "properties": {
        "cupboards": {
          "format": "int32",
          "type": "integer"
        },
        "discordWhen": {
          "type": "string",
          "description": "always or all_offline."
        },
        "lastRead": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the newest cupboard was read; absent before the first read."
        },
        "lowHours": {
          "format": "int32",
          "type": "integer"
        },
        "saved": {
          "type": "boolean"
        },
        "tellPlayers": {
          "type": "boolean"
        }
      },
      "required": [
        "saved",
        "tellPlayers",
        "lowHours",
        "discordWhen",
        "cupboards"
      ],
      "type": "object"
    },
    "UpkeepTrailResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": "string"
        },
        "cupboardId": {
          "type": "string"
        },
        "kind": {
          "type": "string",
          "description": "reached, recovered or message."
        },
        "level": {
          "type": [
            "null",
            "string"
          ],
          "description": "low, last_hours or ran_out."
        },
        "outcome": {
          "type": [
            "null",
            "string"
          ],
          "description": "What happened to a message: sent_chat, sent_discord, held, dropped_on_recovery, snoozed, alerts_off, no_link, superseded or teammate_online."
        }
      },
      "required": [
        "at",
        "cupboardId",
        "kind"
      ],
      "type": "object"
    },
    "UploadFileResponse": {
      "properties": {
        "path": {
          "type": "string"
        },
        "sha256": {
          "type": "string"
        },
        "size": {
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "path",
        "size",
        "sha256"
      ],
      "type": "object",
      "description": "One file the server's host holds: its path inside the upload, its size and its fingerprint."
    },
    "UploadLinkDataBody": {
      "properties": {
        "content": {
          "type": [
            "null",
            "string"
          ],
          "description": "The file, base64 encoded."
        }
      },
      "type": "object",
      "description": "The file a member uploads to move their links from another link service:\nits bytes as base64 text, at most (4 MiB) before encoding."
    },
    "UploadResponse": {
      "properties": {
        "detail": {
          "type": [
            "null",
            "string"
          ],
          "description": "The path the reason is about; null when it names none."
        },
        "expiresAt": {
          "format": "date-time",
          "type": "string"
        },
        "files": {
          "items": {
            "$ref": "#/$defs/UploadFileResponse"
          },
          "type": "array",
          "description": "The files on the host, once `ready`: names, sizes and fingerprints, never contents."
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "operationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The host operation that carries the upload to the host, once it was asked for; null before."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why it ended badly, as a stable code (`waiting_expired`, `upload_expired`, `damaged`, `no_room`, `refused_name`, `refused_type`, `refused_archive`, `too_big`, `unknown`); null otherwise."
        },
        "receivedBytes": {
          "format": "int64",
          "type": "integer"
        },
        "serverId": {
          "type": "string"
        },
        "state": {
          "type": "string",
          "description": "`uploading` (bytes are still due), `complete` (the cloud holds every byte, checked), `waiting` (asked to go to the host, which has not taken it yet),\n`receiving` (the host is taking it), `ready` (the host holds the files and checked them), `failed`, `expired` or `cancelled`."
        },
        "totalBytes": {
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "id",
        "serverId",
        "name",
        "state",
        "receivedBytes",
        "totalBytes",
        "expiresAt",
        "files"
      ],
      "type": "object",
      "description": "An upload as the page shows it."
    },
    "UploadTicketResponse": {
      "properties": {
        "chunkBytes": {
          "format": "int32",
          "type": "integer",
          "description": "The size of one chunk in bytes (8 MiB)."
        },
        "ticket": {
          "type": "string",
          "description": "A secret for this one upload, used as a bearer on the chunk requests only. Returned here once and never again; asking for the same drop again gives a new one and ends this one."
        },
        "upload": {
          "$ref": "#/$defs/UploadResponse"
        },
        "url": {
          "type": "string",
          "description": "Where the chunks go (`HEAD` for the offset, `PATCH` at the offset, `DELETE` to stop)."
        }
      },
      "required": [
        "upload",
        "ticket",
        "url",
        "chunkBytes"
      ],
      "type": "object",
      "description": "The answer to a start: the upload, its one-time ticket and where to send the chunks."
    },
    "UseTimedChangeFolderBody": {
      "properties": {
        "expectedRevision": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The revision the member read."
        },
        "exportOperationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The operation ID of the finished export of this change at that revision; the save is refused unless its result says verified."
        }
      },
      "type": "object",
      "description": "Use a folder: save the change as one that reads its folder, naming the finished, verified export."
    },
    "ValidationProblem": {
      "properties": {
        "blockingOperationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "`operation_conflict`: the operation blocking this request."
        },
        "blockingState": {
          "type": [
            "null",
            "string"
          ],
          "description": "`operation_conflict`: that operation's state, `queued`, `running` or `outcome_unknown`."
        },
        "capability": {
          "type": [
            "null",
            "string"
          ],
          "description": "`capability_unavailable`: the capability the target lacks."
        },
        "code": {
          "type": "string",
          "description": "Stable machine code from the error catalog. New codes are additive, so clients treat unknown codes as other."
        },
        "currentRevision": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "`revision_conflict`: the current revision of the resource."
        },
        "dependency": {
          "type": [
            "null",
            "string"
          ],
          "description": "`dependency_unavailable`: the dependency that is down."
        },
        "detail": {
          "type": "string",
          "description": "Fixed, safe next step."
        },
        "errors": {
          "items": {
            "$ref": "#/$defs/FieldError"
          },
          "type": "array",
          "description": "One entry per invalid field, never repeating the rejected value."
        },
        "header": {
          "type": [
            "null",
            "string"
          ],
          "description": "`precondition_required`: the header the request needs, `If-Match`."
        },
        "permission": {
          "type": [
            "null",
            "string"
          ],
          "description": "`forbidden`: the permission that is missing."
        },
        "pointer": {
          "type": [
            "null",
            "string"
          ],
          "description": "`state_conflict` on a body reference: the JSON pointer of the member that refers to it."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "A stable reason within the code, for example `host_offline` or `not_detached`."
        },
        "retryAfterSeconds": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Seconds to wait before repeating, or null when no useful wait is known."
        },
        "retryable": {
          "type": "boolean",
          "description": "True only when repeating the identical request may succeed later without any change and cannot duplicate work."
        },
        "scope": {
          "type": [
            "null",
            "string"
          ],
          "description": "`insufficient_scope`: the OAuth scope the token lacks."
        },
        "state": {
          "type": [
            "null",
            "string"
          ],
          "description": "`state_conflict` and `workspace_unavailable`: the current state, when it may be shown."
        },
        "status": {
          "format": "int32",
          "type": "integer",
          "description": "HTTP status code."
        },
        "title": {
          "type": "string",
          "description": "Short fixed sentence for the code or reason; safe to show."
        },
        "traceId": {
          "type": "string",
          "description": "W3C trace ID of the request."
        },
        "type": {
          "type": "string",
          "description": "`https://docs.rustsc.com/errors/{code}`, a public page per code."
        }
      },
      "required": [
        "errors",
        "type",
        "title",
        "status",
        "detail",
        "code",
        "traceId",
        "retryable",
        "retryAfterSeconds"
      ],
      "type": "object",
      "description": "The `validation_failed` problem: every Problem field plus the field errors."
    },
    "WaitingInvitationListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/WaitingInvitationResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "Always null: the list is returned in one page."
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The number of items."
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount"
      ],
      "type": "object",
      "description": "The invitations waiting for the signed-in person, newest first; empty when there are none."
    },
    "WaitingInvitationResponse": {
      "properties": {
        "hosts": {
          "format": "int32",
          "type": "integer",
          "description": "How many hosts the person may see, read-only; 0 when none."
        },
        "invitationId": {
          "type": "string",
          "description": "Invitation ID, for `acceptWaitingInvitation`."
        },
        "serverRoles": {
          "items": {
            "$ref": "#/$defs/InvitationOfferedRoleResponse"
          },
          "type": "array"
        },
        "workspaceId": {
          "type": "string"
        },
        "workspaceName": {
          "type": "string"
        },
        "workspaceRole": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/InvitationOfferedRoleResponse"
            }
          ]
        }
      },
      "required": [
        "workspaceId",
        "invitationId",
        "workspaceName",
        "workspaceRole",
        "serverRoles",
        "hosts"
      ],
      "type": "object",
      "description": "An invitation waiting for the signed-in person's own email address: the workspace, what accepting gives, and the ID to accept it by."
    },
    "WarningLineResponse": {
      "properties": {
        "remainingSeconds": {
          "format": "int32",
          "type": "integer"
        },
        "text": {
          "type": "string"
        }
      },
      "required": [
        "remainingSeconds",
        "text"
      ],
      "type": "object",
      "description": "One line of a previewed countdown."
    },
    "WarningMessageItem": {
      "properties": {
        "action": {
          "type": "string"
        },
        "defaultMessage": {
          "type": "string"
        },
        "message": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "action",
        "message",
        "defaultMessage"
      ],
      "type": "object",
      "description": "One action's message: the member's text, or null for the built-in text, and the built-in text itself."
    },
    "WarningMessagePreviewBody": {
      "properties": {
        "action": {
          "type": [
            "null",
            "string"
          ],
          "description": "One of `restart`, `stop`, `game_update`, `framework_update` and `wipe`."
        },
        "message": {
          "type": [
            "null",
            "string"
          ],
          "description": "The message to preview; empty or absent previews the built-in text."
        },
        "warningMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Whole minutes from 0 to 60; absent is the normal warning (5)."
        }
      },
      "type": "object",
      "description": "A message to preview: the action it belongs to, its text (empty is the built-in text) and the warning to preview it for."
    },
    "WarningMessagePreviewResponse": {
      "properties": {
        "action": {
          "type": "string"
        },
        "lines": {
          "items": {
            "$ref": "#/$defs/WarningLineResponse"
          },
          "type": "array"
        },
        "warningMinutes": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "action",
        "warningMinutes",
        "lines"
      ],
      "type": "object",
      "description": "The lines a countdown would say, in order, exactly as the host would send them."
    },
    "WarningMessagesBody": {
      "properties": {
        "frameworkUpdate": {
          "type": [
            "null",
            "string"
          ],
          "description": "Before an Oxide or Carbon change."
        },
        "gameUpdate": {
          "type": [
            "null",
            "string"
          ],
          "description": "Before Update game."
        },
        "restart": {
          "type": [
            "null",
            "string"
          ],
          "description": "Before a restart."
        },
        "stop": {
          "type": [
            "null",
            "string"
          ],
          "description": "Before a stop."
        },
        "wipe": {
          "type": [
            "null",
            "string"
          ],
          "description": "Before a map wipe."
        }
      },
      "type": "object",
      "description": "The five countdown messages of a server. Each is a one-line template that names\n`{remaining_time}` (for example `Server restarting in {remaining_time:words}.`); empty\nor absent is the built-in text. Longer than 200 characters, on several lines or with another\nvariable is refused with `422`."
    },
    "WarningMessagesResponse": {
      "properties": {
        "delivery": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OperationResponse",
              "description": "The operation that gives the saved messages to the host, as it is now; null when never saved."
            }
          ]
        },
        "messages": {
          "items": {
            "$ref": "#/$defs/WarningMessageItem"
          },
          "type": "array",
          "description": "One item for each of `restart`, `stop`, `game_update`, `framework_update` and `wipe`, in that order."
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "Raised by every save that changes something; 0 means never saved."
        },
        "updatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the messages were last saved, UTC; null when never saved."
        }
      },
      "required": [
        "messages",
        "revision",
        "updatedAt",
        "delivery"
      ],
      "type": "object",
      "description": "A server's countdown messages."
    },
    "WebhookAlert": {
      "properties": {
        "category": {
          "type": "string",
          "description": "`availability`, `operations` or `resources`."
        },
        "data": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/WebhookAlertData",
              "description": "The facts of the sentence as separate fields, so a receiver need not read the sentence. Omitted when the alert has none (additive, customer API 325)."
            }
          ]
        },
        "event": {
          "type": "string",
          "description": "What happened to the alert: `opened`, `reminder`, `flapping` or `recovered`."
        },
        "kind": {
          "type": "string",
          "description": "The kind of alert, from the public catalog (for example `server_down`). New kinds may appear; receivers treat an unknown kind as a general alert."
        },
        "message": {
          "type": "string",
          "description": "One plain sentence with the target's name in it and, for an alert that has them, the player's name and Steam ID, the reason in plain words, the chat message and the\nwatched word, the plugin names, or the value and the limit (\"Dave (Steam ID 76561198000000000) was kicked from Main. Reason: Griefing.\"). The same facts are in WebhookAlertData? WebhookAlert.Data."
        },
        "occurredAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the update happened, in UTC."
        },
        "severity": {
          "type": "string",
          "description": "`critical`, `warning` or `info`."
        },
        "state": {
          "type": "string",
          "description": "`open` while the problem lasts, `resolved` once it ended."
        },
        "target": {
          "$ref": "#/$defs/WebhookTarget",
          "description": "What the alert is about: a server, a host or the workspace."
        }
      },
      "required": [
        "event",
        "kind",
        "category",
        "severity",
        "state",
        "occurredAt",
        "target",
        "message"
      ],
      "type": "object",
      "description": "One alert update inside a WebhookEvent."
    },
    "WebhookAlertData": {
      "properties": {
        "chatMessage": {
          "type": [
            "null",
            "string"
          ],
          "description": "What the player said, for a chat word alert."
        },
        "limit": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The limit the value passed."
        },
        "matchedWord": {
          "type": [
            "null",
            "string"
          ],
          "description": "The watched word that matched, for a chat word alert."
        },
        "playerName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The player's name, for a player joined, left, kicked, banned or chat word alert."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "The reason in plain words: the one a member gave for a kick or ban, or why a backup, restore, restart, update or wipe failed."
        },
        "reportText": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a new F7 report, what the reporter wrote. Plain text from a player: never markup or a command."
        },
        "reportType": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a new F7 report, the game's type word (for example `Cheat`)."
        },
        "reportedPlayerName": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a new F7 player report, the name of the player it is about."
        },
        "reportedSteamId": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a new F7 player report, the Steam ID of the player it is about: digits only."
        },
        "reporterName": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a new F7 report, the name of the player who sent it."
        },
        "steamId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The player's Steam ID: digits only (17 to 20 of them)."
        },
        "unit": {
          "type": [
            "null",
            "string"
          ],
          "description": "`percent`, with long? WebhookAlertData.Value and long? WebhookAlertData.Limit."
        },
        "value": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The measured value of a CPU or memory alert, in string? WebhookAlertData.Unit."
        }
      },
      "type": "object",
      "description": "The facts an alert carries, each present only when the alert has it. Plain text: a name or message is what a player or a member typed, so a receiver treats it as text and never as\nmarkup, a command or an address to fetch. Never an IP address, a key, a path or a raw reason code."
    },
    "WebhookChangeBody": {
      "properties": {
        "categories": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "What the webhook gets; at least one of `availability`, `operations` and `resources`."
        },
        "enabled": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Whether it sends. Default true. Turning a paused webhook on resumes it."
        },
        "label": {
          "type": [
            "null",
            "string"
          ],
          "description": "A new name; absent keeps the saved one."
        },
        "url": {
          "type": [
            "null",
            "string"
          ],
          "description": "A different address; absent keeps the saved one."
        }
      },
      "required": [
        "categories"
      ],
      "type": "object",
      "description": "A change to a webhook. `PUT` replaces the name, the categories and the switch; the address stays unless a new one is given."
    },
    "WebhookCreateBody": {
      "properties": {
        "categories": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "What the webhook gets: any of `availability`, `operations` and `resources`. At least one."
        },
        "enabled": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Whether it sends now. Default true."
        },
        "label": {
          "type": [
            "null",
            "string"
          ],
          "description": "What you call it, for example \"Support bot\". Optional; up to 60 characters."
        },
        "url": {
          "type": "string",
          "description": "The address RustSC sends alerts to: `https://`, a public name and no sign-in in it. The whole address is kept secret."
        }
      },
      "required": [
        "url",
        "categories"
      ],
      "type": "object",
      "description": "A new webhook. The address is write-only."
    },
    "WebhookDeliveriesResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/WebhookDeliveryResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object",
      "description": "A webhook's delivery log, newest first."
    },
    "WebhookDeliveryResponse": {
      "properties": {
        "at": {
          "format": "date-time",
          "type": "string"
        },
        "attempt": {
          "format": "int32",
          "type": "integer",
          "description": "Which try this was for the alert (1 is the first)."
        },
        "kind": {
          "type": "string",
          "description": "`alert`, `summary` (updates held back to limit notifications), `test` or `paused` (RustSC paused the webhook)."
        },
        "outcome": {
          "type": "string",
          "description": "`delivered`, `retrying` (will be sent again), `failed` or `paused`."
        },
        "problem": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why it did not arrive: `unreachable`, `timed_out`, `secure_connection_failed`, `rate_limited`, `server_error`, `address_refused`, `redirected`, `rejected`, `expired`, `route_changed`, `route_off`, `no_confirmation`, `destination_not_configured` or `destination_unreadable`; null when delivered."
        },
        "status": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The HTTP status your receiver answered with, when it answered."
        }
      },
      "required": [
        "kind",
        "outcome",
        "problem",
        "status",
        "attempt",
        "at"
      ],
      "type": "object",
      "description": "One row of a webhook's delivery log."
    },
    "WebhookEvent": {
      "properties": {
        "createdAt": {
          "format": "date-time",
          "type": "string",
          "description": "When this body was created, in UTC. Retries keep it."
        },
        "heldBack": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "For a summary: how many updates were held back. Omitted otherwise."
        },
        "id": {
          "type": "string",
          "description": "The event reference, also sent as the `webhook-id` header. The same for every retry of the same delivery; receivers use it to ignore duplicates."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/WebhookAlert"
          },
          "type": "array",
          "description": "The alert updates, oldest first. Empty for a summary."
        },
        "schemaVersion": {
          "type": "string",
          "description": "The schema version, string WebhookEvent.Version."
        },
        "synthetic": {
          "type": "boolean",
          "description": "True for a test, whose items describe nothing that happened."
        },
        "type": {
          "type": "string",
          "description": "`alert` (one or more alert updates), `summary` (updates held back to limit notifications) or `test` (a test from the portal)."
        }
      },
      "required": [
        "schemaVersion",
        "id",
        "type",
        "createdAt",
        "synthetic",
        "items"
      ],
      "type": "object",
      "description": "The body of a webhook delivery. Times are UTC with a trailing `Z`. Treat names as text."
    },
    "WebhookKeyResponse": {
      "properties": {
        "signingKey": {
          "type": "string",
          "description": "The signing key, `whsec_` and base64. Use it as the Standard Webhooks secret to verify every delivery."
        },
        "webhook": {
          "$ref": "#/$defs/WebhookResponse"
        }
      },
      "required": [
        "webhook",
        "signingKey"
      ],
      "type": "object",
      "description": "A webhook together with its signing key. The key is returned this once and cannot be read again; make a new one to recover."
    },
    "WebhookListResponse": {
      "properties": {
        "canManage": {
          "type": "boolean",
          "description": "Whether the signed-in member may create, change, test and remove webhooks (`integrations.manage`)."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/WebhookResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items",
        "canManage"
      ],
      "type": "object",
      "description": "A workspace's webhooks."
    },
    "WebhookResponse": {
      "properties": {
        "categories": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "What it gets: `availability`, `operations`, `resources`."
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "id": {
          "type": "string",
          "description": "The webhook's ID (`whk_`)."
        },
        "label": {
          "type": "string"
        },
        "lastDelivery": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/WebhookDeliveryResponse",
              "description": "The newest delivery or test, or null before the first."
            }
          ]
        },
        "oldKeyValidUntil": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "While set, the previous signing key still signs next to the new one, until this time."
        },
        "paused": {
          "type": "boolean",
          "description": "True when RustSC switched it off after repeated failed deliveries. Turn it on to resume."
        },
        "pausedReason": {
          "type": [
            "null",
            "string"
          ],
          "description": "The problem that ended the last failed delivery before the pause; null when not paused."
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "Raised by every change that alters what is sent where."
        },
        "updatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "id",
        "label",
        "categories",
        "enabled",
        "paused",
        "pausedReason",
        "revision",
        "createdAt",
        "updatedAt",
        "oldKeyValidUntil",
        "lastDelivery"
      ],
      "type": "object",
      "description": "One customer webhook. Never the address and never a key."
    },
    "WebhookSampleResponse": {
      "properties": {
        "body": {
          "type": "string",
          "description": "The exact bytes of that body as sent, the text the signature covers."
        },
        "event": {
          "$ref": "#/$defs/WebhookEvent",
          "description": "The sample body as a document (schema version 1). It is a test: `type` is `test` and `synthetic` is true."
        },
        "headers": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The headers of every delivery: `webhook-id`, `webhook-timestamp` and `webhook-signature`, plus `Content-Type: application/json`."
        }
      },
      "required": [
        "event",
        "body",
        "headers"
      ],
      "type": "object",
      "description": "What a receiver is sent: a sample body and the headers that come with it."
    },
    "WebhookTarget": {
      "properties": {
        "id": {
          "type": "string",
          "description": "The target's public reference, the same ID the RustSC API uses (`srv_...`, `host_...` or `ws_...`)."
        },
        "kind": {
          "type": "string",
          "description": "`server`, `host` (a host running servers) or `workspace` (an event about the whole workspace, for example a Discord link). Treat a kind you do not know as a general target."
        },
        "name": {
          "type": "string",
          "description": "The name the member gave it. Plain text. A workspace has no name here: it reads `Your workspace`."
        }
      },
      "required": [
        "kind",
        "id",
        "name"
      ],
      "type": "object",
      "description": "The server, host or workspace an alert is about, as the member sees it in RustSC."
    },
    "WebhookTestResponse": {
      "properties": {
        "delivered": {
          "type": "boolean"
        },
        "problem": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why not (see the delivery log's `problem` values); null when delivered."
        },
        "status": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The HTTP status the receiver answered with, when it answered."
        }
      },
      "required": [
        "delivered",
        "problem",
        "status"
      ],
      "type": "object",
      "description": "Whether the receiver took the test delivery."
    },
    "WipeExtraListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/WipeExtraResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object"
    },
    "WipeExtraResponse": {
      "properties": {
        "address": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a plugin_source the member took from an approved address: that address; otherwise absent. The host fetches the file at the wipe and nothing is stored on the host before. An address can hold a token (a download link made for one buyer), so it is returned only to a member who may add plugins (servers.files.write and plugins.manage on the server);\neveryone else gets the site alone."
        },
        "bytes": {
          "format": "int64",
          "type": "integer"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "files": {
          "items": {
            "$ref": "#/$defs/WipeFileResponse"
          },
          "type": "array"
        },
        "id": {
          "type": "string"
        },
        "kind": {
          "type": "string"
        },
        "label": {
          "type": "string"
        },
        "leavesOut": {
          "type": [
            "null",
            "string"
          ],
          "description": "For leave_out: the template line it skips."
        },
        "planId": {
          "type": [
            "null",
            "string"
          ]
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "One plain sentence for unavailable and failed."
        },
        "repeat": {
          "type": "string"
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "serverId": {
          "type": "string"
        },
        "site": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a plugin_source from an address: the site it is fetched from (`example.com`), for everyone who can read the server; empty when the address cannot be read. Absent for every other extra."
        },
        "state": {
          "type": "string",
          "description": "`uploading`, `waiting`, `ready`, `in_place`, `used`, `unavailable` or `failed`."
        },
        "stateAt": {
          "format": "date-time",
          "type": "string"
        },
        "target": {
          "$ref": "#/$defs/WipeTargetResponse"
        },
        "templateId": {
          "type": [
            "null",
            "string"
          ]
        },
        "usedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When it was last taken out at a wipe and used; null until then."
        },
        "versionLabel": {
          "type": [
            "null",
            "string"
          ],
          "description": "For an address: the plugin version the check read from the approved file."
        }
      },
      "required": [
        "id",
        "serverId",
        "planId",
        "templateId",
        "kind",
        "label",
        "target",
        "repeat",
        "state",
        "reason",
        "stateAt",
        "usedAt",
        "files",
        "bytes",
        "leavesOut",
        "revision",
        "createdAt"
      ],
      "type": "object"
    },
    "WipeFileBody": {
      "properties": {
        "path": {
          "type": [
            "null",
            "string"
          ],
          "description": "The path below the extra's folder, forward slashes."
        },
        "sha256": {
          "type": [
            "null",
            "string"
          ],
          "description": "The fingerprint of the file, 64 lowercase hexadecimal characters."
        },
        "size": {
          "format": "int64",
          "type": "integer",
          "description": "The size in bytes."
        }
      },
      "type": "object",
      "description": "One file of an extra as the browser listed it."
    },
    "WipeFileResponse": {
      "properties": {
        "path": {
          "type": "string"
        },
        "sha256": {
          "type": "string"
        },
        "size": {
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "path",
        "size",
        "sha256"
      ],
      "type": "object"
    },
    "WipeMapRequestBody": {
      "properties": {
        "admission": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/AdmissionBody"
            }
          ]
        },
        "backup": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "False skips the backup before the files go; true takes it. Absent follows the server's \"Back up before changes\" setting (on until it is switched off)."
        },
        "blueprints": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True also resets every player's blueprints. False or absent keeps them."
        },
        "clans": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True also resets the clans. False or absent keeps them."
        },
        "fingerprint": {
          "type": "string",
          "description": "A wipe whose world no longer matches it is refused before anyone is warned (plan_changed): plan again."
        },
        "keepMap": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "At least one other category must then be reset."
        },
        "level": {
          "type": [
            "null",
            "string"
          ],
          "description": "Absent for a custom map."
        },
        "levelUrl": {
          "type": [
            "null",
            "string"
          ]
        },
        "mapName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The map's name after the wipe: letters, digits, spaces and . , ' ! ? &amp; + - ( ) only, up to 31 bytes, never containing \"official\". Absent leaves it as it is; empty clears it. Not together with `keepMap`."
        },
        "planId": {
          "type": [
            "null",
            "string"
          ],
          "description": "A saved wipe (`wpl_...`) to run, as it is now. Absent for the simple wipe."
        },
        "playerData": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True also resets player data. False or absent keeps it."
        },
        "rotationEntry": {
          "type": [
            "null",
            "string"
          ],
          "description": "Absent for a wipe that is not a rotation's."
        },
        "seed": {
          "format": "int64",
          "type": "integer"
        },
        "startAfter": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "False leaves the server stopped afterwards, as a stop does. Absent or true starts it again."
        },
        "warningMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Minutes of player warning before the server stops, from 0 to the longest warning (60); players\nsee a countdown in chat. Absent means the normal warning of 5 minutes; 0 stops at once."
        },
        "wipeDateName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The server name the wipe date is added to once the server is back up (`My Server` becomes `My Server 3 Dec`), 1 to 100 characters. Absent leaves the name alone."
        },
        "wipeDateZone": {
          "type": [
            "null",
            "string"
          ],
          "description": "Only with `wipeDateName`: the time zone, for example `Australia/Brisbane`. Absent means UTC."
        },
        "worldSize": {
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "seed",
        "worldSize",
        "fingerprint"
      ],
      "type": "object",
      "description": "A wipe: the values and fingerprint of the plan the member reviewed, the player warning and the optional admission choices."
    },
    "WipeOptionsBody": {
      "properties": {
        "backup": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "False skips the protective backup. Absent or true takes it first."
        },
        "blueprints": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True also resets every player's blueprints."
        },
        "clans": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True also resets the clans."
        },
        "keepMap": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True keeps the map and what was built on it, so only the categories chosen are reset."
        },
        "level": {
          "type": [
            "null",
            "string"
          ],
          "description": "`Procedural Map` for a generated map (`seed` and `worldSize` apply), the name of a map that comes with Rust, or\nabsent to keep the server's kind of map. Not together with `levelUrl` or `keepMap`."
        },
        "levelUrl": {
          "type": [
            "null",
            "string"
          ],
          "description": "The address of a custom map file (`http` or `https`). Not together with `level` or `keepMap`."
        },
        "mapName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The map's name after the wipe: letters, digits, spaces and . , ' ! ? &amp; + - ( ) only, up to 31 bytes, never containing \"official\". Absent leaves it as it is; empty clears it. Not together with `keepMap`."
        },
        "planId": {
          "type": [
            "null",
            "string"
          ],
          "description": "Only on a schedule's `wipe`: the wipe plan (`wpl_...`) it runs; none is the simple wipe. Ignored elsewhere."
        },
        "playerData": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True also resets player data (deaths, identities, states and tokens)."
        },
        "rotation": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/RotationBody",
              "description": "A rotation of maps: each wipe uses the next map of the list. Instead of a single map; see RotationBody."
            }
          ]
        },
        "seed": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The seed of a generated map, 0 to 2147483647. A scheduled wipe uses it once; later wipes draw a random seed. Absent is random."
        },
        "startAfter": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "False leaves the server stopped afterwards. Absent or true starts it again."
        },
        "wipeDateName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The server name the wipe date is added to after each wipe that worked (`My Server` becomes `My Server 3 Dec`),\n1 to 100 characters. Absent is off."
        },
        "wipeDateZone": {
          "type": [
            "null",
            "string"
          ],
          "description": "Only with `wipeDateName`: the time zone, for example `Australia/Brisbane`. Absent means UTC."
        },
        "worldSize": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "The world size of a generated map in metres, 1000 to 6000. Absent means the current size."
        }
      },
      "type": "object",
      "description": "What a wipe does: the map, what else is reset, whether the server starts again and whether a backup is taken first. Every member is optional; absent is the\ndefault wipe: a new random map of the kind the server has, blueprints, player data and clans kept, a backup first, the server started again."
    },
    "WipeOptionsResponse": {
      "properties": {
        "backup": {
          "type": "boolean"
        },
        "blueprints": {
          "type": "boolean"
        },
        "clans": {
          "type": "boolean"
        },
        "keepMap": {
          "type": "boolean"
        },
        "level": {
          "type": [
            "null",
            "string"
          ],
          "description": "`Procedural Map`, a built-in map's name, or null for the kind of map the server has."
        },
        "levelUrl": {
          "type": [
            "null",
            "string"
          ]
        },
        "mapName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name of the map after the wipe; null leaves the server's map name as it is, empty clears it."
        },
        "planId": {
          "type": [
            "null",
            "string"
          ],
          "description": "Only on a schedule's `wipe`: the saved wipe it runs (`wpl_...`); null otherwise."
        },
        "playerData": {
          "type": "boolean"
        },
        "rotation": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/RotationBody",
              "description": "The rotation of maps; null when the wipe does not rotate."
            }
          ]
        },
        "seed": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ]
        },
        "startAfter": {
          "type": "boolean"
        },
        "wipeDateName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name the wipe date is added to; null when off."
        },
        "wipeDateZone": {
          "type": [
            "null",
            "string"
          ],
          "description": "Only with `wipeDateName`: the time zone the date is taken in; null is UTC."
        },
        "worldSize": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ]
        }
      },
      "required": [
        "level",
        "levelUrl",
        "seed",
        "worldSize",
        "keepMap",
        "blueprints",
        "playerData",
        "clans",
        "startAfter",
        "backup",
        "mapName",
        "rotation"
      ],
      "type": "object",
      "description": "The options of a wipe as saved, every member present."
    },
    "WipePlanBody": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "One to 40 characters, unique on the server."
        },
        "options": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/WipeOptionsBody",
              "description": "Absent uses the template's."
            }
          ]
        },
        "steps": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/WipeStepsBody"
            }
          ]
        },
        "templateId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The template (`wtp_...`)."
        },
        "warningMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Absent uses the template's."
        }
      },
      "type": "object"
    },
    "WipePlanListResponse": {
      "properties": {
        "active": {
          "items": {
            "$ref": "#/$defs/WipePlanResponse"
          },
          "type": "array"
        },
        "finished": {
          "items": {
            "$ref": "#/$defs/WipePlanResponse"
          },
          "type": "array"
        },
        "storage": {
          "$ref": "#/$defs/WipeStorageResponse"
        },
        "upcoming": {
          "items": {
            "$ref": "#/$defs/WipePlanResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "active",
        "upcoming",
        "finished",
        "storage"
      ],
      "type": "object"
    },
    "WipePlanResponse": {
      "properties": {
        "advanced": {
          "type": "boolean"
        },
        "changesFiles": {
          "type": "boolean",
          "description": "True when the next run adds or removes files, which needs servers.files.write besides worlds.reset."
        },
        "changesPlugins": {
          "type": "boolean",
          "description": "True when the next run updates or adds plugins, which needs plugins.manage."
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "extras": {
          "items": {
            "$ref": "#/$defs/WipeExtraResponse"
          },
          "type": "array"
        },
        "group": {
          "type": "string",
          "description": "`active` (running, or its extras are in place), `upcoming` or `finished`."
        },
        "id": {
          "type": "string"
        },
        "lastRun": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/WipeRunResponse"
            }
          ]
        },
        "lastRunAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        },
        "name": {
          "type": "string"
        },
        "options": {
          "$ref": "#/$defs/WipeOptionsResponse"
        },
        "paused": {
          "type": "boolean"
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "runningOperationId": {
          "type": [
            "null",
            "string"
          ]
        },
        "scheduleId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The schedule that arms it (`sch_...`), or null."
        },
        "serverId": {
          "type": "string"
        },
        "state": {
          "type": "string",
          "description": "`draft` (not scheduled), `upcoming` or `finished`, as stored."
        },
        "steps": {
          "$ref": "#/$defs/WipeStepsResponse"
        },
        "storageBytes": {
          "format": "int64",
          "type": "integer"
        },
        "templateId": {
          "type": "string"
        },
        "templateName": {
          "type": "string"
        },
        "templateRevision": {
          "format": "int64",
          "type": "integer",
          "description": "The template's revision now."
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        },
        "warningMinutes": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "id",
        "serverId",
        "name",
        "group",
        "state",
        "paused",
        "advanced",
        "revision",
        "templateId",
        "templateName",
        "templateRevision",
        "scheduleId",
        "options",
        "warningMinutes",
        "steps",
        "extras",
        "changesFiles",
        "changesPlugins",
        "runningOperationId",
        "lastRunAt",
        "lastRun",
        "storageBytes",
        "createdAt",
        "updatedAt"
      ],
      "type": "object"
    },
    "WipePluginsBody": {
      "properties": {
        "hold": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The plugin files `all` never updates; not with mode `leave`."
        },
        "mode": {
          "type": [
            "null",
            "string"
          ],
          "description": "`leave` (the default), `all` or `only`."
        },
        "only": {
          "items": {
            "type": "string"
          },
          "type": [
            "null",
            "array"
          ],
          "description": "The plugin files to update, for example `Kits.cs`; only with mode `only`."
        }
      },
      "type": "object",
      "description": "How plugins are handled at the wipe: left alone, all updated except the held ones, or only the named ones updated."
    },
    "WipePluginsResponse": {
      "properties": {
        "hold": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "mode": {
          "type": "string"
        },
        "only": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "mode",
        "only",
        "hold"
      ],
      "type": "object"
    },
    "WipePreviewGroupResponse": {
      "properties": {
        "bytes": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ]
        },
        "files": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ]
        },
        "key": {
          "type": "string"
        },
        "lines": {
          "items": {
            "$ref": "#/$defs/WipePreviewLineResponse"
          },
          "type": "array"
        },
        "summary": {
          "type": "string"
        },
        "title": {
          "type": "string"
        }
      },
      "required": [
        "key",
        "title",
        "summary",
        "lines",
        "files",
        "bytes"
      ],
      "type": "object"
    },
    "WipePreviewLineResponse": {
      "properties": {
        "detail": {
          "type": [
            "null",
            "string"
          ]
        },
        "note": {
          "type": [
            "null",
            "string"
          ]
        },
        "text": {
          "type": "string"
        }
      },
      "required": [
        "text",
        "detail",
        "note"
      ],
      "type": "object"
    },
    "WipePreviewResponse": {
      "properties": {
        "after": {
          "items": {
            "$ref": "#/$defs/WipePreviewLineResponse"
          },
          "type": "array"
        },
        "before": {
          "items": {
            "$ref": "#/$defs/WipePreviewLineResponse"
          },
          "type": "array"
        },
        "changesFiles": {
          "type": "boolean"
        },
        "changesPlugins": {
          "type": "boolean"
        },
        "groups": {
          "items": {
            "$ref": "#/$defs/WipePreviewGroupResponse"
          },
          "type": "array"
        },
        "name": {
          "type": "string"
        },
        "planId": {
          "type": "string"
        },
        "stages": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The step stages the wipe will declare, in order."
        },
        "templateName": {
          "type": "string"
        }
      },
      "required": [
        "planId",
        "name",
        "templateName",
        "before",
        "groups",
        "after",
        "changesFiles",
        "changesPlugins",
        "stages"
      ],
      "type": "object"
    },
    "WipeRunExtraResponse": {
      "properties": {
        "label": {
          "type": "string"
        },
        "outcome": {
          "type": "string",
          "description": "`placed`, `removed`, `left_out` or `failed`."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "label",
        "outcome",
        "reason"
      ],
      "type": "object"
    },
    "WipeRunListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/WipeRunResponse"
          },
          "type": "array",
          "description": "The latest runs, newest first (at most 50)."
        }
      },
      "required": [
        "items"
      ],
      "type": "object"
    },
    "WipeRunResponse": {
      "properties": {
        "endedAt": {
          "format": "date-time",
          "type": "string"
        },
        "extras": {
          "items": {
            "$ref": "#/$defs/WipeRunExtraResponse"
          },
          "type": "array"
        },
        "failedStage": {
          "type": [
            "null",
            "string"
          ]
        },
        "id": {
          "type": "string"
        },
        "operationId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The wipe operation (`op_...`); null for a skipped occurrence."
        },
        "planId": {
          "type": "string"
        },
        "reason": {
          "type": [
            "null",
            "string"
          ]
        },
        "result": {
          "type": "string",
          "description": "`done`, `done_with_notes`, `failed` or `skipped`."
        },
        "startedAt": {
          "format": "date-time",
          "type": "string"
        },
        "steps": {
          "items": {
            "$ref": "#/$defs/WipeRunStepResponse"
          },
          "type": "array"
        },
        "templateRevision": {
          "format": "int64",
          "type": "integer"
        },
        "via": {
          "type": "string",
          "description": "`schedule` or `wipe_now`."
        }
      },
      "required": [
        "id",
        "planId",
        "startedAt",
        "endedAt",
        "via",
        "templateRevision",
        "result",
        "failedStage",
        "reason",
        "steps",
        "extras",
        "operationId"
      ],
      "type": "object"
    },
    "WipeRunStepResponse": {
      "properties": {
        "line": {
          "type": "string",
          "description": "A plain line such as \"12 files removed\"."
        },
        "note": {
          "type": "boolean",
          "description": "True for a line about something that did not go as asked, for example a plugin that could not be updated; the run's result is then done_with_notes."
        },
        "stage": {
          "type": "string"
        }
      },
      "required": [
        "stage",
        "line"
      ],
      "type": "object"
    },
    "WipeSettingsBody": {
      "properties": {
        "keepHours": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Wipes within this many hours of the last wipe that counted do not take out \"This wipe only\" files or end temporary changes that end at the wipe, from 0 to 168. Absent leaves the number as it is; 24 is the normal number."
        },
        "options": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/WipeOptionsBody",
              "description": "The wipe's choices; absent saves the default wipe."
            }
          ]
        },
        "warningMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Minutes of player warning before the server stops, from 0 to the longest warning (60). Absent means the normal warning of 5 minutes."
        }
      },
      "type": "object",
      "description": "A server's saved wipe settings to store: the choices and the player warning. Saving changes nothing on the server."
    },
    "WipeSettingsResponse": {
      "properties": {
        "countedWipeAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the last wipe that counted did its work, UTC; null when none has."
        },
        "keepHours": {
          "format": "int32",
          "type": "integer",
          "description": "Hours that must pass after a wipe that counted before the next wipe counts as \"the next wipe\"; 24 while nothing was saved."
        },
        "options": {
          "$ref": "#/$defs/WipeOptionsResponse",
          "description": "The wipe's choices; the default wipe while nothing was saved."
        },
        "revision": {
          "format": "int64",
          "type": "integer",
          "description": "Raised by every save that changes something; 0 means never saved."
        },
        "updatedAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the settings were last saved, UTC; null when never saved."
        },
        "warningMinutes": {
          "format": "int32",
          "type": "integer",
          "description": "Minutes of player warning; 5 while nothing was saved."
        }
      },
      "required": [
        "options",
        "warningMinutes",
        "keepHours",
        "countedWipeAt",
        "revision",
        "updatedAt"
      ],
      "type": "object",
      "description": "A server's saved wipe settings: what the Wipe page starts from."
    },
    "WipeStepsBody": {
      "properties": {
        "leftoverWorld": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True removes saves and maps left from earlier wipes. Every file is listed before the wipe."
        },
        "oldLogs": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True removes logs that have not changed for a week."
        },
        "plugins": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/WipePluginsBody"
            }
          ]
        },
        "updateGame": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "True installs a pending game build before the world is removed."
        }
      },
      "type": "object",
      "description": "The steps of a wipe besides its files."
    },
    "WipeStepsResponse": {
      "properties": {
        "leftoverWorld": {
          "type": "boolean"
        },
        "oldLogs": {
          "type": "boolean"
        },
        "plugins": {
          "$ref": "#/$defs/WipePluginsResponse"
        },
        "updateGame": {
          "type": "boolean"
        }
      },
      "required": [
        "updateGame",
        "oldLogs",
        "leftoverWorld",
        "plugins"
      ],
      "type": "object",
      "description": "The steps of a wipe, every member present."
    },
    "WipeStorageItemResponse": {
      "properties": {
        "bytes": {
          "format": "int64",
          "type": "integer"
        },
        "label": {
          "type": "string"
        },
        "planName": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "required": [
        "label",
        "planName",
        "bytes"
      ],
      "type": "object"
    },
    "WipeStorageResponse": {
      "properties": {
        "biggestUnused": {
          "items": {
            "$ref": "#/$defs/WipeStorageItemResponse"
          },
          "type": "array",
          "description": "The biggest saved items that will do nothing again (used up, unavailable or failed), for the message when an upload would pass the limit."
        },
        "limitBytes": {
          "format": "int64",
          "type": "integer"
        },
        "usedBytes": {
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "usedBytes",
        "limitBytes",
        "biggestUnused"
      ],
      "type": "object"
    },
    "WipeTargetBody": {
      "properties": {
        "framework": {
          "type": [
            "null",
            "string"
          ],
          "description": "`oxide` or `carbon`."
        },
        "mode": {
          "type": [
            "null",
            "string"
          ],
          "description": "For a delete line that names a folder: `delete_folder` (the default) or `empty_folder` (keep the folder)."
        },
        "path": {
          "type": [
            "null",
            "string"
          ],
          "description": "A path below the folder with forward slashes. For added files the folder they go into (empty is the folder itself); for a delete line the file, folder or name pattern (`*`, `?` in the last name); for a plugin the file name, for example `Kits.cs`."
        },
        "place": {
          "type": [
            "null",
            "string"
          ],
          "description": "`plugins`, `config`, `data`, `lang` or `logs` (a delete line only)."
        }
      },
      "type": "object",
      "description": "Where an extra goes: the framework's folder and a path below it."
    },
    "WipeTargetResponse": {
      "properties": {
        "folder": {
          "type": "string",
          "description": "The real folder as a person knows it, for example `oxide/data` or `carbon/configs`."
        },
        "framework": {
          "type": "string"
        },
        "mode": {
          "type": [
            "null",
            "string"
          ]
        },
        "path": {
          "type": "string"
        },
        "place": {
          "type": "string"
        }
      },
      "required": [
        "framework",
        "place",
        "path",
        "folder",
        "mode"
      ],
      "type": "object"
    },
    "WipeTemplateBody": {
      "properties": {
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "One to 40 characters, unique on the server. Usual wipe keeps its name."
        },
        "options": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/WipeOptionsBody",
              "description": "The wipe's choices; absent is the default wipe. For Usual wipe these are the server's saved wipe settings."
            }
          ]
        },
        "steps": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/WipeStepsBody"
            }
          ]
        },
        "warningMinutes": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Minutes of player warning, 0 to 60. Absent is the normal warning of 5 minutes."
        }
      },
      "type": "object",
      "description": "A template to save: a name, the wipe's options and warning, and its steps. A template keeps its own copy of its options, so changing another template never changes it."
    },
    "WipeTemplateListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/WipeTemplateResponse"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object"
    },
    "WipeTemplateResponse": {
      "properties": {
        "id": {
          "type": "string"
        },
        "isDefault": {
          "type": "boolean",
          "description": "True for Usual wipe, the template every server has, whose options are the server's saved wipe settings."
        },
        "lines": {
          "items": {
            "$ref": "#/$defs/WipeExtraResponse"
          },
          "type": "array",
          "description": "The lines of the template: files added and removed at every wipe that uses it."
        },
        "name": {
          "type": "string"
        },
        "options": {
          "$ref": "#/$defs/WipeOptionsResponse"
        },
        "planCount": {
          "format": "int32",
          "type": "integer"
        },
        "revision": {
          "format": "int64",
          "type": "integer"
        },
        "serverId": {
          "type": "string"
        },
        "steps": {
          "$ref": "#/$defs/WipeStepsResponse"
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        },
        "warningMinutes": {
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "id",
        "serverId",
        "name",
        "isDefault",
        "revision",
        "options",
        "warningMinutes",
        "steps",
        "lines",
        "planCount",
        "updatedAt"
      ],
      "type": "object"
    },
    "WorkspaceBanBody": {
      "properties": {
        "expiresInSeconds": {
          "format": "int64",
          "type": [
            "null",
            "integer"
          ],
          "description": "How long the ban lasts from now, 60 to 31536000 seconds; leave it out for a ban that never ends."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The name stored with the ban when the player is not connected; optional."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "The reason the game keeps and shows; optional."
        },
        "steamId": {
          "type": [
            "null",
            "string"
          ],
          "description": "The player's 17 digit Steam ID, as a string. Required."
        }
      },
      "type": "object",
      "description": "A ban to keep for the whole workspace: on every server now and on every server added later (`POST .../player-bans`)."
    },
    "WorkspaceBanChangeResponse": {
      "properties": {
        "ban": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/WorkspaceBanResponse",
              "description": "The ban as it is now; null after it was lifted."
            }
          ]
        },
        "keptOnServers": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "After a lift: the servers (`srv_...`) that ban the player on their own and so keep the ban. Empty otherwise."
        },
        "plan": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/BulkPlanResponse",
              "description": "The bulk plan over the servers that exist now, already applied, exactly as `createBulkPlan` and `applyBulkPlan` return it (read it with `getBulkPlan`, retry with\n`retryBulkPlan`). The servers that were offline and the servers added later receive the change from the\nworkspace's own pass when they are connected."
            }
          ]
        },
        "steamId": {
          "type": "string"
        }
      },
      "required": [
        "steamId",
        "keptOnServers"
      ],
      "type": "object",
      "description": "What adding or lifting a workspace ban did."
    },
    "WorkspaceBanResponse": {
      "properties": {
        "alsoServerBans": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The servers (`srv_...`) that also ban the player on their own: they keep the ban when this global ban is lifted."
        },
        "appliedOnServers": {
          "format": "int32",
          "type": "integer",
          "description": "On how many of `serverCount` servers the game holds the ban now. Counts only; the servers are in the Activity."
        },
        "by": {
          "$ref": "#/$defs/OperationActorResponse",
          "description": "Who made it."
        },
        "createdAt": {
          "format": "date-time",
          "type": "string",
          "description": "When the ban was made."
        },
        "expiresAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the ban ends; null for a ban that never ends. A server added later receives only the time that remains."
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "reason": {
          "type": [
            "null",
            "string"
          ]
        },
        "serverCount": {
          "format": "int32",
          "type": "integer",
          "description": "The servers the list writes to: every server of the workspace that is not removed and not on a restricted host, those added later too."
        },
        "steamId": {
          "type": "string"
        }
      },
      "required": [
        "steamId",
        "createdAt",
        "by",
        "appliedOnServers",
        "serverCount",
        "alsoServerBans"
      ],
      "type": "object",
      "description": "One ban of the workspace's list."
    },
    "WorkspaceBansResponse": {
      "properties": {
        "canManage": {
          "type": "boolean",
          "description": "Whether the caller may add and remove workspace bans: `players.moderate` held for the whole workspace."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/WorkspaceBanResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "Pass it as `cursor` for the next page; null on the last page."
        },
        "serverCount": {
          "format": "int32",
          "type": "integer",
          "description": "The servers the list writes to."
        },
        "totalCount": {
          "format": "int32",
          "type": "integer",
          "description": "Bans in force that match the search."
        }
      },
      "required": [
        "items",
        "totalCount",
        "serverCount",
        "canManage"
      ],
      "type": "object",
      "description": "One page of the workspace's bans, newest first, 50 to a page."
    },
    "WorkspaceClosingResponse": {
      "properties": {
        "contents": {
          "items": {
            "$ref": "#/$defs/ClosingContentResponse"
          },
          "type": "array",
          "description": "What closing deletes after the download window, by kind and number, so the person sees it before confirming. The audit trail is not listed."
        },
        "deletionWait": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/DeletionWaitResponse"
            }
          ]
        }
      },
      "required": [],
      "type": "object"
    },
    "WorkspaceListResponse": {
      "properties": {
        "items": {
          "items": {
            "$ref": "#/$defs/WorkspaceResponse"
          },
          "type": "array",
          "description": "Workspaces ordered by name."
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "Always null: the list is returned in one page."
        },
        "totalCount": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "The number of items."
        }
      },
      "required": [
        "items",
        "nextCursor",
        "totalCount"
      ],
      "type": "object",
      "description": "The workspaces the caller is an active member of, in one page."
    },
    "WorkspacePlayerResponse": {
      "properties": {
        "avatar": {
          "type": [
            "null",
            "string"
          ],
          "description": "The identifier of the player's Steam picture; null when there is none. The picture is at `https://avatars.steamstatic.com/{avatar}.jpg`."
        },
        "discordName": {
          "type": [
            "null",
            "string"
          ],
          "description": "The Discord name of the player's link, also when it is the same as `name`. Only for a caller who holds `links.manage`, or `players.moderate` for the whole list; null with no link or while the name is not known yet."
        },
        "entities": {
          "format": "int32",
          "type": [
            "null",
            "integer"
          ],
          "description": "Everything the player owns on the server named by `serverId`, from that server's newest count. Only for a caller who holds `worlds.read` on that server; null with no server named, no count yet, or a count that does not name the player."
        },
        "entitiesAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the count behind `entities` was finished; null with it."
        },
        "firstSeenAt": {
          "format": "date-time",
          "type": "string",
          "description": "The first time RustSC saw the player."
        },
        "globalBan": {
          "type": "boolean",
          "description": "True when the workspace's global ban list bans the player now."
        },
        "lastSeenAt": {
          "format": "date-time",
          "type": "string",
          "description": "The last time RustSC saw the player on any server."
        },
        "name": {
          "type": [
            "null",
            "string"
          ],
          "description": "The newest name the player was seen under; null when no session carried one."
        },
        "online": {
          "type": "boolean",
          "description": "True while RustSC holds an open session of the player on any server."
        },
        "serverBans": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The servers (`srv_...`) that ban the player on their own through RustSC."
        },
        "servers": {
          "items": {
            "$ref": "#/$defs/WorkspacePlayerServerResponse"
          },
          "type": "array",
          "description": "The servers the player was seen on, connected ones first, then the newest."
        },
        "sessionSeconds": {
          "format": "int64",
          "type": "integer",
          "description": "Seconds connected in the current session while `online`, otherwise in the previous (last finished) session. Counted on the named server when `serverId` is given. 0 when RustSC holds no session length."
        },
        "steamId": {
          "type": "string",
          "description": "The 17 digit Steam ID, as a string."
        },
        "totalSeconds": {
          "format": "int64",
          "type": "integer",
          "description": "Seconds connected over every session the history holds (an open session counts up to this read). Counted on the named server when `serverId` is given."
        }
      },
      "required": [
        "steamId",
        "online",
        "firstSeenAt",
        "lastSeenAt",
        "servers",
        "globalBan",
        "serverBans",
        "sessionSeconds",
        "totalSeconds"
      ],
      "type": "object",
      "description": "One player of the workspace, connected or not."
    },
    "WorkspacePlayerServerResponse": {
      "properties": {
        "lastSeenAt": {
          "format": "date-time",
          "type": "string",
          "description": "The last time RustSC saw the player on this server: now-ish while online, otherwise when they left."
        },
        "online": {
          "type": "boolean",
          "description": "True while RustSC holds an open session of the player on this server."
        },
        "serverId": {
          "type": "string",
          "description": "The server (`srv_...`)."
        }
      },
      "required": [
        "serverId",
        "online",
        "lastSeenAt"
      ],
      "type": "object",
      "description": "One server a player was seen on (`GET .../players`)."
    },
    "WorkspacePlayersResponse": {
      "properties": {
        "canModerate": {
          "type": "boolean",
          "description": "Whether the caller may ban and lift bans for this list."
        },
        "items": {
          "items": {
            "$ref": "#/$defs/WorkspacePlayerResponse"
          },
          "type": "array"
        },
        "nextCursor": {
          "type": [
            "null",
            "string"
          ],
          "description": "Opaque; pass it as `cursor` for the next page. Null on the last page."
        },
        "totalCount": {
          "format": "int32",
          "type": "integer",
          "description": "Players that match the search and the filters."
        }
      },
      "required": [
        "items",
        "totalCount",
        "canModerate"
      ],
      "type": "object",
      "description": "One page of the workspace's players: connected first, then the newest last seen, 50 to a page."
    },
    "WorkspaceResponse": {
      "properties": {
        "closing": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ClosingResponse",
              "description": "Set while the workspace is closing: when it was closed, when its data is deleted and why. Null otherwise."
            }
          ]
        },
        "deletionWait": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/DeletionWaitResponse",
              "description": "Null otherwise."
            }
          ]
        },
        "id": {
          "type": "string",
          "description": "Workspace ID, for example `ws_01jb8z3k4q7v9w2x5y6z8a0b1c`."
        },
        "inactivity": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/InactivityResponse",
              "description": "Present only while nobody has used this free workspace for so long that it is about to close, or has closed for that reason. Opening the workspace, or any API or MCP use, puts it back to normal."
            }
          ]
        },
        "membership": {
          "$ref": "#/$defs/MembershipResponse",
          "description": "The caller's membership in this workspace."
        },
        "name": {
          "type": "string",
          "description": "The workspace name. A label only; it is not unique."
        },
        "signInRestriction": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/SignInRestrictionResponse",
              "description": "Set when this workspace's own sign-in rule does not allow the caller's current session: the membership then holds no permissions and\nevery other request for the workspace answers `409 state_conflict` with the same reason, until the caller signs in again."
            }
          ]
        },
        "signInRuleEndsAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the caller's current session stops meeting this workspace's sign-in length, so the portal can ask for a new sign-in as the person\narrives. Absent when the workspace sets no length. The rule itself is still checked on every request."
        },
        "state": {
          "type": "string",
          "description": "`active`, `suspended` or `closing`. Treat unknown values as other."
        }
      },
      "required": [
        "id",
        "name",
        "state",
        "membership"
      ],
      "type": "object",
      "description": "A workspace the caller is a member of, with the caller's own membership."
    },
    "WorkspaceTimeZoneRequestBody": {
      "properties": {
        "timeZone": {
          "type": [
            "null",
            "string"
          ],
          "description": "An IANA zone id such as `Europe/Berlin`, or null to clear it."
        }
      },
      "type": "object",
      "description": "The time zone to save for the workspace."
    },
    "WorkspaceTimeZoneResponse": {
      "properties": {
        "timeZone": {
          "type": [
            "null",
            "string"
          ],
          "description": "An IANA zone id, or null when none was saved."
        }
      },
      "required": [
        "timeZone"
      ],
      "type": "object",
      "description": "The time zone saved for the workspace."
    },
    "WorldReadResponse": {
      "properties": {
        "container": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/ContainerItemsResponse",
              "description": "The items in a container."
            }
          ]
        },
        "counts": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/EntityCountsResponse"
            }
          ]
        },
        "find": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/EntityFindResponse"
            }
          ]
        },
        "inspect": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/EntityInspectResponse"
            }
          ]
        },
        "kind": {
          "type": "string",
          "description": "The kind of the operation: `world.entities.count`, `world.entities.find` or `world.entity.inspect`."
        },
        "ownedCounts": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OwnedCountsResponse",
              "description": "Entity counts by owner."
            }
          ]
        },
        "ownedPreview": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/OwnedPreviewResponse",
              "description": "The entities in an ownership preview."
            }
          ]
        },
        "readAt": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ],
          "description": "When the read finished."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Why there is nothing to show: the plugin's reason (`entity_not_found`, `generation_changed`) or the host's (`companion_unavailable:plugin_missing`)."
        },
        "state": {
          "type": "string"
        },
        "structure": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/StructurePreviewResponse",
              "description": "The building from a structure preview."
            }
          ]
        }
      },
      "required": [
        "state",
        "kind"
      ],
      "type": "object",
      "description": "What a finished count, find or inspect found. `state` is `running` until the host has answered, `read` with the answer of the\noperation's kind, or `unavailable` with a reason. Needs worlds.read: the operation record never carries this."
    }
  }
}
